我们正在管理一个 C++/C# 库,我们注意到许多类和函数没有记录在案。
我们考虑编写一个脚本来解析代码以查找未记录的类和方法以生成未记录的类/方法/函数的列表。
我们还希望将 dOxygen 标记放置在缺少文档的位置的脚本。即如果找到这样的代码:
bool Myclass:undocumentedMethod(int a);
它将被替换为
/// \brief <DESCRIPTION>
/// \param a <DESCRIPTION>
/// \return bool <DESCRIBE RETURN VALUE>
bool Myclass:undocumentedMethod(int a);
当然,如果该函数将来有一个自动生成的文档标题但没有人触及该标题,它仍然会在报告中报告为未记录。
您将使用哪种脚本语言来开发这样的工具?
安东尼