使Doxygen与Solidity一起工作

Question

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

问题在于doxygen希望与Classes一起使用，而Solidity则具有合同和库。结果是，在生成的文档中，所有节标题都链接在一起，因此请参考“类”。

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

Answer 1

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

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