Developer Notes for Kajabity Tools

Accessing The Code

Kajabity Tools for C# are available as C# source code for you to copy into your projects – or can be compiled into a DLL which you can link into projects.

You can get a copy of the code in various ways:

  • download the zipped versions of the code (which includes the Sources, Visual Studio project, Help file and compiled DLL),
  • clone or fork the GitHub repository (or you can download a zipped copy of the source files from the repository).
  • ...or you could fork it on GitHub.

Project Environment

Whilst the source code for Kajabity Tools itself does not depend on any particular environment it might be useful to have a quick overview of the different tools I’m using in its development.

The C# code itself is now developed using Visual Studio 2013, which I’ve recently upgraded to. I’ve used older versions in the past and started the project originally using Sharp Develop.

I have a number of Visual Studio plugins to help me with particular aspects of the development:

  • Git Source Control Provider – ensured VS was aware of the Source Control aspect of the project and let me add and commit some changes.
  • SHFB (Sandcastle Help File Builder) – enabled me to add a Help project to build the compiled help (Kajabity Tools.chm) from the C# sources.
  • NUnit Test Adapter – helped me to create, execute and debug the NUnit tests in the Kajabity Tools.Test project.

As well as these, I also make use of:

  • Git command line – as an alternative to the plugin, I do a lot of the Git stuff through the command line.
  • Subversion command line – I keep the additional files (such as this web site, etc.) in a local subversion repository and using a different SCM means that the two repositories don’t interfere, as long as I setup the “ignore” files correctly.
  • Nant – Used to build the zipped distribution files for each version.
  • Maven – most recently, to build this web site.

Testing

For the latest release (v0.3), I’ve added a few more Unit Tests using NUnit. These tests use a number of sample files for both Java Properties and CSV files (which are copied to the output folder to make it easy for the tests to find them).

The tests run in Visual Studio with the test runner.

You can also test that the code is working correctly using the sample applications.