C++中的文档字符串设施

Doc string facility in C++

本文关键字：字符串 设施 文档 C++      更新时间：2023-10-16

像Python，MATLAB，E-Lisp这样的语言对doc-strings都有很好的工具。使用此功能，只需在终端中击键几下，您就可以获取已编写并导入到代码中的函数/模块的文档。

现在是否有任何"技术"（库，编辑器技巧，无论什么）都可以获得类似的设施C++/C. 假设我在源文件中包含函数的文档函数的负责人，然后我想在终端上输入一个命令，例如 getinfo。（某物像手册页）

我知道许多 C 函数都存在这样的"man"功能，但是这些函数的文档是用源代码单独的文本文件编写的。我想要要就地的文档

你可以使用像doxygen这样的东西。它支持生成手册页以及其他格式。

Visual Studio可以/将生成包含从DocXml格式注释中提取信息的弹出窗口。您必须使用 /doc 进行编译，这会将注释中的 XML 提取到.xdc文件中。然后，您必须运行xdcmake将.xdc文件编译为 xml 文件。您通常会在构建过程中自动处理所有这些，因此您不必手动执行太多操作（当然，除了编写注释本身）。但是，要记住的一件事是，在获取弹出窗口之前，必须构建代码（至少是声明）。

我觉得有必要补充一点，IMO，大多数这样的评论通常都非常接近无用。如果公司标准使它们不可避免，那就这样吧 - 但如果他们诚实地提供了任何有用的信息，我会认为这是问题的迹象（"代码气味"，如果你更喜欢这种措辞）。在大多数情况下，函数名称（或其他名称）和参数名称/类型的组合应该使函数的使用非常清晰。

如果您使用类似于

Javadoc 的语法使用注释来标记代码，则可以使用 Doxygen 以各种不同的格式为您的代码生成文档。它可以生成手册页等，但似乎人们使用的首选输出格式是 HTML 页。

相关文章：