Thursday, March 17, 2016

Code Commenting for an entire Visual Studio Solution

If you have a lot of code in your Visual Studio solution that is uncommented (which is often the case), then you might want to take advantage of a tool/extension that can help fill in the gaps and help you generate some usable Help documentation from your code base.

There are several tools on the market such as the following:

Of the above solutions, Atomineer Pro is by far the most affordable solution and based on this comparison matrix seems more fully featured than GhostDoc Pro:

For example, GhostDoc Pro cannot document an entire project or an entire solution, while Atomineer Pro can!

Furthermore, GhostDoc Pro has indicated that they WILL NEVER add this feature!!

On the other hand, as you can see from the comparison Atomineer Pro still does not provide support for CHM Export like GhostDoc Pro does.

Fortunately, you can use this free and open source project on CodePlex to build your CHM files from your code:

With the combination of these 2 tools you can have an affordable code commenting solution for your Visual Studio projects/solutions that can help provide more complete code documentation for your developers/end-users!

No comments:

Post a Comment