6
Vote

Generate Documentation in Factory?

description

I have personally found that the best way to learn and understand CAB/SCSF is to go through each the files generated by SCSF and document each class and function. It forces me to understand what's going on, and it's actually helpful to have that Intellisense pop up when I'm coding later on. It's also helpful to let me figure out what SCSF generates that I will never need.
 
The code is great, and I sincerely appreciate it. But surely you guys must be documenting each function and parameter over there? I can't be working for the only company that has strict documentation requirements. I'm not talking about "obvious" documentation: I'm talking about a "what this class is," "how and why you might use it," and "pitfalls to watch out for," not in some separate CHM that the developers will never read, but sitting right there in the class.
 
Why can't this code documentation be generated along with the code? I think it'd go a long, long way to reducing the number of documentation complaints in the forums.

comments

davidstew wrote Mar 1, 2007 at 8:01 AM

I agree. It would be great if the code was commented as this would assist with the learning curve. An additional request would be that the code conforms to FxCop coding standards as I work for a client that enforces a strict check-in policy in TFS.