《十分钟文档化你的C.doc》由会员分享，可在线阅读，更多相关《十分钟文档化你的C.doc（7页珍藏版）》请在金锄头文库上搜索。
1、十分钟文档化你的C+代码DoxyGen VS2003、VS2005、JAVA等都配备了代码文档化的工具，你想在VC6中也拥有这么酷的工具吗？本文就让你梦想成真。只需要十分钟哦。:)在把你的代码文档化之前，你可能会有以下的疑问：一、为什么需要软件文档？1、可能你的公司需要一些文档。2、如果过半年，你还能认得你的代码吗?3、你的同事可能会经常烦着你，为什么这段代码你这样写啊？。4、你可能将要离开公司或者退休了，但你并不想你的代码从此被扔进垃圾桶里，毕竟这是你的心血。5、你觉得需要。二、为什么使用自动化的文档生成工具？1、你可能随时会改变你的注释，例如函数说明，如果不使用自动化工具，你就要打开你的W
2、ORD文档去查找函数说明，然后改变它。2、重用你的注释。3、自动帮助你的文档格式化，并且可以使用超链接关联。4、你的代码虽然包含了很重要的信息，但是在你的注释里，会藏着更重要的信息。这些注释将会影响到你的同事，你程序的测试者，你的经理。三、为什么使用DoxyGen？1、因为它是免费的，开源的，可配置的。现在的版本是1.4.7。你可以在下面的地址下载到它：http:/www.doxygen.org/download.html好了，如果上面的疑问都解答后，下面让我们看看怎么使用DoxyGen在你的代码中使用特定的格式写注释：1、使用/注释，例如：/ 这是一个结构体/ 它是用来获取矩形信息的stru
3、ct SNAPINFO/ .2、使用/*/来写注释，例如：/*这是一个类*/class CHi/ .还有其他的注释符号，详细的可以查看DoxyGen的帮助文档。3、把下面的文本拷贝到指定的文件中（GenDoc.bat和default.doxygen）GenDoc.bat文件里的内容：d:program filesdoxygenbindoxygen.exe default.doxygen注意：d:program filesdoxygenbindoxygen.exe 只是我安装DoxyGen的路径，你可以自己选择你的安装路径。default.doxygen文件里的内容# Doxyfile 1.3-
4、rc2#-# General configuration options#-PROJECT_NAME = Project NamePROJECT_NUMBER = OUTPUT_DIRECTORY = OUTPUT_LANGUAGE = ChineseEXTRACT_ALL = YESEXTRACT_PRIVATE = NOEXTRACT_STATIC = YESEXTRACT_LOCAL_CLASSES = YESHIDE_UNDOC_MEMBERS = NOHIDE_UNDOC_CLASSES = NOHIDE_FRIEND_COMPOUNDS = NOHIDE_IN_BODY_DOCS
5、= NOBRIEF_MEMBER_DESC = YESREPEAT_BRIEF = YESALWAYS_DETAILED_SEC = NOINLINE_INHERITED_MEMB = NOFULL_PATH_NAMES = NOSTRIP_FROM_PATH = INTERNAL_DOCS = NOCASE_SENSE_NAMES = YESSHORT_NAMES = NOHIDE_SCOPE_NAMES = NOVERBATIM_HEADERS = YESSHOW_INCLUDE_FILES = YESJAVADOC_AUTOBRIEF = YESMULTILINE_CPP_IS_BRIE
6、F = NODETAILS_AT_TOP = YESINHERIT_DOCS = NOINLINE_INFO = YESSORT_MEMBER_DOCS = NODISTRIBUTE_GROUP_DOC = YESTAB_SIZE = 8GENERATE_TODOLIST = YESGENERATE_TESTLIST = YESGENERATE_BUGLIST = YESGENERATE_DEPRECATEDLIST= YESALIASES = ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30OPTIMIZE_OUTPUT_FOR_C = YESOPT
7、IMIZE_OUTPUT_JAVA = NOSHOW_USED_FILES = YES#-# configuration options related to warning and progress messages#-QUIET = NOWARNINGS = YESWARN_IF_UNDOCUMENTED = YESWARN_IF_DOC_ERROR = YESWARN_FORMAT = $file($line): $textWARN_LOGFILE = #-# configuration options related to the input files#-INPUT = .FILE_
8、PATTERNS = *.cpp *.c *.h *.cxx *.idlRECURSIVE = YESEXCLUDE = EXCLUDE_SYMLINKS = NOEXCLUDE_PATTERNS = EXAMPLE_PATH = EXAMPLE_PATTERNS = EXAMPLE_RECURSIVE = NOIMAGE_PATH = INPUT_FILTER = FILTER_SOURCE_FILES = NO#-# configuration options related to source browsing#-SOURCE_BROWSER = YESINLINE_SOURCES =
9、NOSTRIP_CODE_COMMENTS = YESREFERENCED_BY_RELATION = NOREFERENCES_RELATION = NO#-# configuration options related to the alphabetical class index#-ALPHABETICAL_INDEX = YESCOLS_IN_ALPHA_INDEX = 4IGNORE_PREFIX = #-# configuration options related to the HTML output#-GENERATE_HTML = YESHTML_OUTPUT = doxydocHTML_FILE_EXTENSION = .htmlHTML_HEADER = HTML_FOOTER = HTML_STYLESHEET = HTML_ALIGN_MEMBERS = YESGENERATE_HTMLHELP = NOCHM_FILE = HHC_DemoUrl = GENERATE_CHI = NOBINARY_TOC = NOTOC_EXPAND = NODISABLE_INDEX = NOENUM_VALUES_PER_LINE = 4GENERATE_TREEVIEW = NOTREEVIEW_WIDTH = 250#-
