如何在Doxygen中嵌入带注释且可编译的源代码/示例?

博里斯拉夫·斯坦尼罗夫(Borislav Stanimirov)

我想在我的软件中有一个可编译的示例,该示例带有注释,因此可以包含在doxygen中.dox这里的关键部分是我希望注释成为源代码的一部分(应该是doxygen的全部要点,但似乎缺少此简单功能)

因此,是否可以像看起来的文本和代码的混合形式那样包含它,就像此处\dontinclude示例一样

\snippet-s似乎没有用,因为它们需要将注释与代码分开。同样的道理\dontinclude

我现在唯一的想法是编写一个脚本来用作预强氧步骤,该脚本将解析示例源并生成.dox带有文本和\code块的文件

博里斯拉夫·斯坦尼罗夫(Borislav Stanimirov)

好吧...我写了上面提到的脚本。

我将其张贴在这里,以防遇到相同问题的人有所帮助:https : //gist.github.com/iboB/925542e1ed5afee2b0083ff4fa970462

要点中有一个示例用法

本文收集自互联网,转载请注明来源。

如有侵权,请联系 [email protected] 删除。

编辑于
0

我来说两句

0 条评论
登录 后参与评论

相关文章

如何在保持.py源代码可编辑的同时将python打包到exe?

如何在Windows中编译Golang源代码

如何编译Minix源代码?

如何在OpenShift上编译和安装源代码?

如何在Visual Studio IDE中从github查看源代码,但如何使用Nuget的dll进行编译?

如何在Rust源代码注释文档中包括ASCII艺术图/图表?

如何使用Doxygen在源代码中不完整地枚举枚举类值

rustc如何从bash进程替代中编译源代码,但gcc无法编译源代码?

在源代码中嵌入编译器选项

使用AsciiDoctor,如何在源代码块和示例块中传递变量?

配置Doxygen以忽略源代码注释语言(SAL)

如何在嵌入式源代码中使用组织模式源块中的变量?

如何在Intellij的依赖项中查看源代码(包括注释)

如何在macOS中编译Traefik的源代码以做出贡献?

如何在源代码中要求通过

在Doxygen中使用Microsoft的源代码注释语言(SAL)?

如何从源代码编译InfluxDB

在C ++中嵌入libmicrohttpd代码或如何编译此示例?

如何在17.10上从源代码编译Geany

如何在Linux上从C源代码生成nasm可编译汇编代码?

如何在“ THEN”中打印“ IF”条件的源代码

如何从源代码编译readline?

调试器停止了不可编译的源代码。

如何在C ++中分别编译源代码

如何在Hadoop 2.7.0上编译MapReduce作业源代码?

如何在代码块中获取预编译的源代码?

如何在ubuntu中编译SQLite3的原始源代码?

如何在Debian 9上从源代码中编译Breeze for GTK主题?

我们如何在flex / bison源代码中添加注释?

TOP 榜单

热门标签

归档