像 Python、MATLAB、E-Lisp 这样的语言有这个很好的文档字符串工具。使用此功能，只需在终端中按几下键，您就可以获取已编写并导入代码的函数/模块的文档。
现在是否有任何“技术”（库、编辑器技巧等）在 C++/C 中获得类似的设施。假设我在函数头部的源文件中包含函数的文档，那么我想在终端输入类似 getinfo 的命令。（类似于手册页）
我知道许多 C 函数都存在这样的“人”工具，但这些函数的文档是在与源代码不同的文本文件中编写的。我希望文档到位
问问题
7453 次
3 回答
1
Visual Studio 可以/将生成包含从DocXml格式的注释中提取的信息的弹出窗口。您必须使用 进行编译/doc，这会将 XML 从注释中提取到.xdc文件中。然后你必须运行xdcmake将.xdc文件编译成一个xml文件。您通常会在构建过程中自动处理所有这些，因此您不必手动执行太多操作（当然，除了自己编写注释之外）。但是，要记住的一件事是，在获得弹出窗口之前必须构建代码（至少是声明）。
我觉得有必要补充一下 IMO，大多数这样的评论通常都非常接近无用。如果企业标准使它们不可避免，那就这样吧 - 但如果他们诚实地提供任何有用的信息，我会认为这是一个问题的迹象（“代码味道”，如果你更喜欢这种措辞）。在大多数情况下，函数名称（或其他名称）和参数名称/类型的组合应该使函数的使用非常清晰。
于 2012-05-28T16:54:06.613 回答
0
如果您使用类似于 Javadoc 的语法为您的代码添加注释，您可以使用Doxygen为您的代码生成各种不同格式的文档。它可以生成手册页，但似乎人们使用的首选输出格式是 HTML 页面。
于 2012-05-28T15:29:06.843 回答