How to document an application or code

Question

I have to document a small code(A Game):

analyze / design / Implement / ...etc the known steps I used to do this in software Eng. but how to do it in case of a code (Visual C#) I need Ideas , No solutions :-) or if there is an example on the net !

thanx in advance .

Answer 1

Use standard documentation markup for C#. Here is a good article explaining how this is accomplished. Your "analyze & design & implementation" comments could go right above your classes along with sample code. You could then download a tool such as NDoc or SandCastle, which will read your assembly documentation markup and generate nice and easily readable documentation.

Answer 2

I would use standard documentation markup, generating output using Sandcastle Help File Builder, which is a great GUI wrapper (and then some) around the Sandcastle project.