如何用doxygen记录if状态,它记录我的所有类、函数,但是我为if状态编写的注释,它考虑下一个最近的变量。
if abc != "": # Here we check if abc is not equal to null and then check if it is equal to some known values
if abc != "red":
if abc != "blue":
error()
if gfh != ""
ghf = 0
它将注释分配给"ghf = 0“,任何知道如何将注释分配给if语句的方法。
发布于 2015-11-06 04:44:32
DO2是一个生成API文档的工具。也就是说,关于功能和使用的文档,将客户端代码的作者作为目标受众。这些人自然不关心实现细节。
您看起来要做的是为代码的维护人员添加文档。这是另一回事,不是由氧气解决的。
我不知道是否有一些工具可以帮助您记录您的控制流,除了一些代码可读性的一般经验规则:
例如,您可以引入一个函数来执行检查,并相应地返回一个布尔值。这纯粹是通过使用标准语言特性来提高可读性。
# you don't even need a comment to find out what the intention is here
if is_invalid(abc):
error()
也可以看看这个职位,也许IPython笔记本也是值得一看的东西。
https://stackoverflow.com/questions/33562222
复制相似问题