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#)?
Share
Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
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
NDocor SandCastle, which will read your assembly documentation markup and generate nice and easily readable documentation.