1

我试图弄清楚如何在我的源文件(或头文件)中放置注释,这样它们就不会出现在我的 Doxygen 文档中。 目前,我不太清楚哪些评论会出现,哪些不会出现。

我经常在我的一个源文件 (.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()当前已被注释掉,可能是因为它不起作用并且我希望将其从构建中排除。但是,当我运行 Doxygen 时,它会

* OCBA P(CS) implementation for "max" problems */ 

进入详细的文档部分OCBA_SC()我怎样才能防止这种情况发生?

以下是我正在使用的相关 Doxygen 配置设置:

#---------------------------------------------------------------------------
# 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            = 
4

1 回答 1

4

如果你只是评论//它不会出现在 doxygen 上。Doxygen 仅解析以某些标记开头的评论,例如/**or /*!

doxygen 文档中描述了已解析的令牌。

于 2012-11-18T19:21:10.117 回答