我正在为绿地应用程序开发一个新框架/ api。我的老板向团队提出的挑战之一是编写框架/ api，以帮助未来的开发人员能够导航代码并发现如何在业务环境中对框架进行编码。虽然我们很幸运基于.NET堆栈的工具来处理像Intellisense这样的东西，但我想知道除了经过验证的真正的编码标准之外还有什么可以帮助新的开发人员找到解决框架的方法吗？代码的结构是否可以“自我记录？”
答案 0 :(得分：2)
使用内联XML注释，并使用SandCastle以编程方式生成联机文档。它不是“自我记录”，但它与创建文档时的摩擦力一样低。
您可以使用StyleCop强制执行此操作（和其他好东西）。如果您正在使用Resharper，您甚至可以使用StyleCop for Resharper插件实时强制执行此操作。
答案 1 :(得分：1)