How to document an application or code [closed]

Closed. This question needs to be more focused. It is not currently accepting answers.

---

Want to improve this question? Update the question so it focuses on one problem only by editing this post.

Closed 4 years ago.

开发者_StackOverflow中文版 Improve this question

I have to document a small piece of code (a game), and document the known steps of software engineering (analyze, design, implement, etc...). How can I do it in the code (Visual C#)?

---

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.

---

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.