我正在努力弄清楚如何在我的源(或头)文件中放置注释,这样它们就不会出现在我的DO2文档中。目前,我不太清楚哪些评论会出现,哪些评论不会出现。
我经常在我的一个源文件(.cpp)中有这样的代码:
///* OCBA P(CS) implementation for "max" problems */
//void OCBA_PCS() {
//
// Code goes here...
//
//}
/*! OCBA minimize simulation cost for "max" problems */
void OCBA_SC() {
// Code goes here...
}
在这里,您可以看到函数OCBA_PCS()
当前被注释掉了,这可能是因为它不起作用,我希望将它排除在构建之外。然而,当我运行氧气,它会
* OCBA P(CS) implementation for "max" problems */
进入OCBA_SC()
的详细文档部分。我怎样才能防止这种情况发生?
下面是我正在使用的相关are配置设置:
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = YES
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = YES
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = NO
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = YES
FORCE_LOCAL_INCLUDES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
SORT_MEMBERS_CTORS_1ST = NO
SORT_GROUP_NAMES = NO
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
SHOW_DIRECTORIES = NO
SHOW_FILES = YES
SHOW_NAMESPACES = YES
FILE_VERSION_FILTER =
LAYOUT_FILE =
发布于 2012-11-18 19:21:10
如果您只使用//
进行评论,它将不会出现在doxygen上。such只解析以某些标记开始的注释,如/**
或/*!
。
解析的令牌在doxygen文档中进行了描述。
https://stackoverflow.com/questions/13443647
复制相似问题