博文
(2010-12-21 21:03:04)
流程1、核對源注釋,檢查語義是否仍正確,修改用object-c代碼寫的注釋。
2、添加原來沒有的注釋
3、生成doxygen文檔,檢查格式是否正確,修改不正確的地方。
4、對於未實現的函數,保留注釋,不出現在文檔。例子1、對實現文件使用C/C++注釋,要求寫明主要的流程、算法,注釋符後要留一個空格。
2、頭文件使用Docxygen風格編寫注釋,要求寫明使用方法,注意要點,dox[閱讀全文]
閱讀 ()評論 (1)
下麵是我個人認為比較常用的標記:@author作者@brief摘要@version版本號@date日期@file文件名,可以默認為空,DoxyGen會自己加@class類名@param函數參數@return函數返回值描述@exce...[閱讀全文]
閱讀 ()評論 (1)
(2010-12-21 20:51:13)
Doxygen心得技術2008-10-0816:24:54閱讀2524評論0字號:大中小訂閱幾年前,看過幾個開源項目的文檔,發現每個開源都會有一個幫助文件,感覺注釋非常詳細。當時就感慨開源項目的人精力充沛。後發覺注釋和代碼有很多相似之處,經過研究,了解到了doxygen。正巧前段時間公司要程序生成文檔,以前很多都是都是手工完成的。經過交流,我們修改了部分源代碼的注釋,同時我寫一個[閱讀全文]
閱讀 ()評論 (0)

學習用doxygen生成源碼文檔ArpanSen,資深工程師,StudioBProductionsArpanSen是一位資深工程師,從事電子設計自動化行業的軟件開發。他花了好幾年研究多種風格的UNIX,包括Solaris、SunOS、HP-UX和IRIX,以及Linux和MicrosoftWindows。他主要對軟件性能優化技術、圖形理論和並行計算感興趣。Arpan擁有軟件係統研究生學位。簡介:維護用C/C++開發的遺留係統並添加新特性是一項艱難的任務。幸運的[閱讀全文]
閱讀 ()評論 (1)
(2010-12-21 20:40:38)

使用doxygen撰文/K.Young翻譯/馬維達(已發表在《程序員》2002年第3期上)一、介紹GLAST軟件已采用doxygen(GNUGPL軟件)來作為文檔工具,本文將對其進行簡單的介紹。要了解更詳細的信息及下載doxygen程序,請訪問網站http://www.stack.nl/~dimitri/doxygen/。什麽是doxygen呢?下麵的介紹錄自doxygen的網頁:“doxygen是一種用於C++、IDL(Corba、Microsoft和KDE-2DCOP風格)和C的文檔係統。它可以通過三種[閱讀全文]
閱讀 ()評論 (0)
(2010-12-21 20:33:13)
來源:http://hi.baidu.com/zkheartboy/blog/item/8ed283cae6a06c80c8176858.htmldoxygen使用詳解2008-10-0513:42為代碼寫注釋一直是大多數程序員有些困擾的事情。當前程序員都能接受為了程序的可維護性、可讀性編碼的同時寫注釋的說法,但對哪些地方應該寫注釋,注釋如何寫,寫多少等這些問題,很多程序員仍然沒有答案。更頭痛的是寫文檔,以及維護文檔的問題,開發人員通常可以忍受編寫或者[閱讀全文]
閱讀 ()評論 (0)
程序文檔,曾經是程序員的一個頭痛問題。寫一個程序文檔,比較花時間,但不是很難;麻煩的是當程序修改後,程序文檔也要跟著同步更新,否則文檔和程序就要脫節,文檔也就變成沒用的東西了。
好在有許多好用的文檔生成器來解決這個問題。目前比較流行的C++文檔生成器是doxygen。
本文就簡單的介紹一下doxygen的文檔注釋方法,以供初學者參考:
C++程序文檔生成[閱讀全文]
閱讀 ()評論 (1)