文档生成-我应该在哪些方框内打勾?

| 我正在要求我的团队为即将到来的一些主要项目更彻底地编写代码,并减轻生活的痛苦,我正在转向XML文档生成器,例如Sandcastle,Doxygen或Box Live Documenter。 在评估最佳选择时,我应牢记哪些主要考虑因素?哪些经验使您做出了特定决定?     
已邀请:
对我来说,关键考虑因素是: 完全自动化:可以这样设置吗? 无需外部工作即可 创建或编辑文档。 全称:可以对文档进行全称吗? 在Wiki或pdf中看起来很棒 生成后。我应该 能够更改颜色,字体大小, 布局等 良好的过滤:我可以只选择我想成为的项目吗 产生。我应该能够 过滤名称空间,文件类型, 类等 自定义:我可以添加页眉,页脚,自定义元素, 等等 我发现Doxygen可以完成所有这一切。我们的工作流程如下: 开发人员更改代码 他们在刚刚更改的代码上方更新文档标签。 我们点击生成按钮 然后,Doxygen将从代码中提取所有XML文档,对其进行过滤以仅包含所需的类和方法,然后应用为此预先创建的CSS样式。我们的最终结果是一个内部Wiki,它看起来像我们想要的样子,不需要编辑。 额外:我们​​所有的项目都在git仓库中。我们将所有这些下拉至一个根文件夹,并从该根文件夹生成文档。 想知道其他人如何进一步实现自动化吗?     
谁为文档付费,为什么? (系统是否足够稳定,是否增加了足够的价值) 谁来阅读它,为什么她不使用更有效的沟通渠道? (如果主要是正确的时间/地点距离) 谁将保持最新状态。 你什么时候要销毁它? (如果在过去的三个月中没有读取或更新过它,它会自动生成吗?) 我最喜欢更好的代码,而不是更多的文档,以减轻生活的痛苦,但是我喜欢场景和单元测试以及高层次的体系结构描述。 [edit]文档花费时间和金钱来编写和保持最新状态。 JavaDoc样式文档对同时可见的代码量具有严重的不利影响,对于使用代码的开发人员而言可能是个好主意,但对于编写代码的开发人员而言则不是一个好主意。     

要回复问题请先登录注册