Docblocks(文档块)是特定格式的多行注释,以/**标识开始,接下来的每行都以*为第一 个字符,并以*/标识注释终止。在每行的前缀前面允许有空格。
还可以考虑在 Docblocks 中加入你的授权协议。 14. 欢迎大家的贡献 想要大家辅助改进项目,那一定要多多请求大家的贡献! 有一份 CONTRIBUTING 文件,列出贡献者的名单。
在Zephir, 多行注释也用作docblocks,它会生成代码, 他们语言的一部分! 注意:如果不是docblock预计的结果编译器将抛出一个异常。
dimitri/doxygen/manual/index.html Documenting the code : http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html
This file demonstrates the rich information that can be included in * in-code documentation through DocBlocks
可以查看下面的网址了解: https://www.doxygen.nl/manual/docblocks.html#cppblock 文档中对应的显示效果如下。
可以在 Doxygen 的 docblocks 描述中找到更多信息(请参阅 进一步阅读 部分中的链接)。 www.doxygen.nl/ FindDoxygen find-module 文档:cmake.org/cmake/help/latest/module/FindDoxygen.html Doxygen 的 docblocks :www.doxygen.nl/manual/docblocks.html#specialblock 其他文档生成工具 还有数十种其他工具未在此书中涉及,因为我们专注于由 CMake 支持的项目。
*/格式,并包含一些特殊标签,这些标签被 Doxygen 理解(参见www.stack.nl/~dimitri/doxygen/manual/docblocks.html)。