C++ 为什么像/**/need'<';?
我的团队C-code指南写道,最好放置一个“我假设您的团队使用一些自动文档工具来查找C++ 为什么像/**/need'<';?,c++,c,doxygen,C++,C,Doxygen,我的团队C-code指南写道,最好放置一个“我假设您的团队使用一些自动文档工具来查找/**,这是doxygen为文件/struct/union/class/enum的成员生成文档的一种方法。通过使用该标记,您可以在每个成员之后添加注释,从而减少混乱。您可以阅读更多信息。这是一个用于在声明/定义后对成员进行评论的注释。正如其他人所回答的,这可能是一个针对doxygen的注释。解析注释时,doxygen有一些特殊规则: doxygen会忽略以/*开头的普通注释 以/**开头的注释被视为源代码中注释
/**,这是doxygen
为文件/struct/union/class/enum的成员生成文档的一种方法。通过使用该标记,您可以在每个成员之后添加注释,从而减少混乱。您可以阅读更多信息。这是一个用于在声明/定义后对成员进行评论的注释。正如其他人所回答的,这可能是一个针对doxygen的注释。解析注释时,doxygen有一些特殊规则:
- doxygen会忽略以
/*
开头的普通注释
- 以
/**
开头的注释被视为源代码中注释后下一项的文档
- 以
/**开头的评论您的团队的答案是什么?为什么人们希望关闭此网站?这是一个完全正确的问题!也许是对文档生成器的一个提示……我相信很少有人从这个问题中学到了一些东西,至于它是否可以被认为是本地化的,meta有一个很好的答案:@VJo:如果这是一个特定于公司的约定,我会同意,但事实证明它是关于doxygen的——目前有413个问题被标记为[doxygen]
。例如,Doxygen使用这些尖括号来描述成员等
#define MAX_PACK_ITEM_NUM 50 /**< max number of item */