用户定义的API生成

Question

当我分析未记录的代码库时，我喜欢将“最重要”的方法记录为单个组。我认为它是一个由我认为有用的方法组成的API。我可以进入对象浏览器并找到有用的对象。但是，当我复制一个方法时，我只获得完全限定的类型名称。我希望这与公共方法（以及可选的XML文档）一起使用。

我希望这个过程高效。可以用相对较少的努力更新的文档。理想情况下，我希望在查看WSDL时最终得到与浏览器中显示的格式化布局类似的内容。有没有办法为我选择的对象生成简洁，可更新的文档？

Answer 1

我最喜欢的一种记录源代码的方法（包括但不限于添加到代码中的手写注释）是doxygen工具。它支持C＃。

既然你提到想要只看到最有用的＆＃34;有用的＆＃34;成员，您可以使用\internal doxygen命令（在特殊注释中）标记不太重要的成员。然后，您可以在生成HTML时使用INTERNAL_DOCS = NO配置显示最有用的文档（设置INTERNAL_DOCS = YES以获得包含每个成员的综合版本。）

Doxygen还提供强大的分组工具，用于为一组类或一组成员编写高级文档。您肯定希望查看手册中的示例。