将开发人员文档添加到Visual Studio项目的最佳方法
基本上，问题是： 我应该在哪里（以哪种格式）存储与我的Visual Studio项目相关的文本开发人员文档？
详细说明：XML注释非常棒，但不包含所有用例。 有时候，您想要高级地描述项目的类架构，向库中添加使用注意事项，或者将其他types的消息留给下一代在此项目中工作的开发人员。
我想直接将这些文档作为文件添加到Visual Studio项目中，以确保（a）开发人员无需进一步search即可使用这些文档，并且（b）版本控制（使用相同的svn / git / whatever repository作为源代码）。
目前，我添加一个文件夹_Documentation到项目和使用文本文件，但我不知道这是否是最好的解决scheme。 Visual Studio没有自动换行文本1的选项，并且在每个更改都令人讨厌之后手动修复换行符。 另一方面，Word文档在版本控制方面效果不佳，而TeX在每个开发人员的电脑上安装和教授都是一件麻烦事。
有没有一个完善的最佳实践呢？
1我知道有Edit / Advanced / Word-Wrap，但这只影响显示，而不影响文件本身。
我只是有同样的问题 – 只有我注意到，我能够添加一个HTML文件。 一旦打开，只需切换到屏幕底部的“devise”。 您可能需要将生成操作从“内容”更改为“无”
由于它是一个硬编码的HTML文档，所以也可以使用内联图片（例如图表）
也为我的目的（编程指南，架构描述，数据库使用示例），我select创build一个单独的项目（ _Documentation ）作为Windows窗体 ，因为这将使我（或一个新的程序员）有一个运行的例子。
我使用GhostDoc（视觉工作室附加组件）为我的项目的文档，因为我添加类，方法，属性等： http : //visualstudiogallery.msdn.microsoft.com/46A20578-F0D5-4B1E-B55D-F001A6345748
在XML注释中，您可以select包含大量数据，然后使用像Sandcastle （站点）这样的工具来获取数据，然后转换为实际的MSDN样式的参考站点。
我倾向于使用这种方法，并使用<para></para>编写长的XML注释（MSDN注释标签） （在适当的情况下）以生成段落并解释未来修改器/开发者所需的任何模式，业务原因或架构信息。 我也用它来举例说明。
一批好的testing（写得好，有名字）也可以真实地说明代码的用途，作为一个规范。
我希望可以在你的研究中提供一些信息:)
XML注释最适合logging特定的方法，而不适合编写长篇概念内容。 长的XML注释可能会对代码的可读性产生不利影响。
我喜欢Sandcastle的概念性主题文档function，我们可以创build和存储概念性文档，无论是function还是体系结构相关，并将其与代码文档（XML注释）合并。 您可以在写概念主题时使用的标记是可扩展的，这意味着我们甚至可以遵守企业模板。
