使 doxygen 与 Solidity 一起工作

Question

我正在研究使用 doxygen 记录 Solidity 代码的想法。 Solidity 与 C# 和其他类 C 语言足够接近，我可以通过告诉 doxygen 将 .sol 文件解释为 .cs 并编写一个工具来按摩原始文件以符合C# 语法。

问题是 doxygen 期望使用类，而 Solidity 有合同和库。结果是在生成的文档中，所有的章节标题都链接了，所以改为引用“类”。

有什么方法可以将 HTML 更改为具有“合同”或“库”而不是类，视情况而定？

Answer 1

关于这个问题有很多方面，一些想法：

• 输入
  • 应将代码转换为 doxygen 可以理解的格式。最好是这样做，最初因为我认为在此阶段通过INPUT_FILTER 为它创建代码扫描器和代码着色器等有点牵强，请参阅 doxygen 文档。
• 输出
  • 由于Solidity 的术语未知，因此一种方法是通过后处理脚本更改所有单词。这非常麻烦并且容易出错，因为一些单词也可能出现在常规文本中。
  • 创建一个本地 (!) 版本的 doxygen 并修改 translator_.. 中您正在使用的自然语言的字符串，并使用它来生成文档。