Question

我正在试图弄清楚如何在我的源文件（或标题文件）中放置评论，这样他们就不会出现在我的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            =

Answer 1

如果您只是对//发表评论，它就不会出现在doxygen上。 Doxygen仅解析以某些令牌开头的评论，例如/**或/*!。

doxygen documentation中描述了解析的令牌。

C ++ Doxygen隐藏评论

1 个答案: