Comments on: C# Documentation (It ain't that hard) http://pathfindersoftware.com/2009/10/documentation-hard/ The Fastest Way to Launch Successful Software Thu, 19 Jan 2012 16:36:03 +0000 hourly 1 http://wordpress.org/?v=3.3.1 By: Greg L http://pathfindersoftware.com/2009/10/documentation-hard/#comment-9795 Greg L Fri, 16 Oct 2009 06:18:03 +0000 http://www.pathf.com/blogs/?p=3260#comment-9795 So would you say that these are the main forms of comments in the code that you need? i.e. inline comments are much less important ("int foo; // counter of foos", "/* Sort through the list and find the highest item */"). Would perhaps a nice rule of thumb be to ensure you use the form of comments you mentioned for all classes and methods, and supplement that with the odd inline comment if needed to explain the functional intent of more complex sections of the code? So would you say that these are the main forms of comments in the code that you need? i.e. inline comments are much less important (“int foo; // counter of foos”, “/* Sort through the list and find the highest item */”).

Would perhaps a nice rule of thumb be to ensure you use the form of comments you mentioned for all classes and methods, and supplement that with the odd inline comment if needed to explain the functional intent of more complex sections of the code?

]]>