Challenge
I recently had the task to create an API library for software I designed for a client. I was looking for a simple way to generate C# documentation using the XML comments in Visual Studio. I work tirelessly to comment each of my functions, and wanted to see my comments put to good use.
Research
I spent several days researching various tools; trying to find the best fit. The first tool I used was NDoc. NDoc was easy to install but appeared to be a dead project as it was only compatible up to .Net 1.1.
Next, I looked into docu. Keeping in mind that docu was in alpha phase, I didn’t expect a full product. I installed this tool on Windows 7 and Windows Server 2003. Neither installation of the tool was successful.
Solution
After experiencing slight defeat, I discovered Doxygen. I was pleased to see the tool had several output formats. This was something of value I could offer to my clients. In addition, I was also pleased to see that Doxygen was compatible with several other languages such as C++, Java, Objective-C, Python, PHP, and others.
I will likely be using Doxygen on future projects. You can get it here.
Recommendations?
If you’ve had a challenge with a similar endeavor, feel free to share your experience and any recommendations for other tools below. Happy coding!
Share and Enjoy: Image may be NSFW.Clik here to view.
Image may be NSFW.Clik here to view.
Image may be NSFW.Clik here to view.
Image may be NSFW.Clik here to view.
Image may be NSFW.Clik here to view.
Image may be NSFW.Clik here to view.
Image may be NSFW.Clik here to view.
Image may be NSFW.Clik here to view.
Image may be NSFW.Clik here to view.
Image may be NSFW.Clik here to view.
Image may be NSFW.Clik here to view.
Image may be NSFW.Clik here to view.
No related posts.
