C++ Doxygen隱藏評論

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中描述。