Hei*_*nzi 41 c# vb.net documentation visual-studio
基本上,问题是:我应该在哪里(以及以何种格式)存储与我的Visual Studio项目相关的文本开发人员文档？
详细说明:XML注释很棒,但它们并不涵盖所有用例.有时,您希望在高级别描述项目的类体系结构,向库中添加使用说明,或者将任何其他类型的消息留给处理此项目的未来几代开发人员.
我想将这些文档作为文件直接添加到Visual Studio项目中,以确保(a)开发人员无需进一步搜索即可使用这些文档,以及(b)它们受版本控制(使用相同的svn/git /任何存储库)作为源代码).
目前,我_Documentation在项目中添加了一个文件夹并使用了文本文件,但我不确定这是否是最佳解决方案.Visual Studio没有自动自动换行文本1的选项,并且在每次更改后手动修复换行符都很烦人.另一方面,Word文档在版本控制方面效果不佳,而TeX在每台开发者PC上设置和教授都太麻烦了.
有没有完善的最佳实践？
1我知道有编辑/高级/自动换行,但这只会影响显示,而不会影响文件本身.
我只是遇到了同样的问题 - 只是我注意到我能够添加一个HTML文件.打开后,只需切换到屏幕底部的"设计".您可能希望将" 构建操作"从"内容" 更改为"无"
由于它是一个硬编码的HTML文档,因此也可以使用内嵌图片(例如图表)
也是出于我的目的(编程指南,架构描述,数据库使用示例)我选择创建一个单独的项目(_Documentation)作为Windows窗体,因为这将允许我(或新程序员)有一个运行的例子.
| 归档时间： |
|
| 查看次数： |
10564 次 |
| 最近记录： |