如何记录应用程序或代码

Question

我必须记录一小段代码（游戏），并记录软件工程的已知步骤（分析，设计，实现等）。我怎么能在代码中做到这一点（Visual C＃）？

Answer 1

为C＃使用标准文档标记。 Here is a good article explaining how this is accomplished.您的“分析与设计与实施”评论可以在您的课程上方以及示例代码上方进行。然后，您可以下载NDoc或SandCastle等工具，它将读取您的程序集文档标记，并生成简单易读的文档。

Answer 2

我会使用standard documentation标记，使用Sandcastle Help File Builder生成输出，这是Sandcastle项目周围的一个很好的GUI包装器（然后是一些）。