Visual Studio 2010:如何使用代码注释生成文档?

我为我的代码写了一些评论。 现在,我如何使用Visual Studio 2010生成文档或类似内容?

在构建属性选项卡中,启用XML文档并使用Sandcastle构建帮助/文档文件。

我描述了一个视觉工作室工具

VSdocman – Visual Studio代码评论者和文档生成器

在专业级别记录您的.NET代码。

为C#和Visual Basic .NET项目生成全面的MSDN样式类文档,包括自定义主题,IntelliSense和F1上下文相关帮助。

通过强大的评论模板和复杂的WYSIWYG评论编辑器,了解代码评论的简便性。

VSdocman是每个Visual Studio开发人员的终极API文档工具 – 无论您是创建类库,组件,控件,应用程序,智能设备还是网站(ASP .NET)。

截图

在此处输入图像描述

在此处输入图像描述

在此处输入图像描述 网站

用于生成文档的另一个众所周知的(外部)系统是Doxygen

使用NDoc 。 NDoc已经过时,但有NDoc3 。 更多选择

  1. 在解决方案资源管理器中选择项目后,在“项目”菜单上单击“属性”。
  2. 单击“生成”选项卡。
  3. 在“构建”页面上,选择XML文档文件。 默认情况下,文件是在指定的输出路径下创建的,例如“bin \ Debug \ Projectname.XML”。

如何:为项目生成XML文档

我使用Sandcastle帮助文件生成器和Sandcastle。 Sandcastle帮助文件生成器是Sandcastle的GUI,可以在使用Sandcastle时消除您的所有痛苦。