Re: [問題] class 的使用說明
※ 引述《RealJustice (19非崇貞,最多是袁紹)》之銘言：
: 自己寫出來的class,
: 想讓別人使用時,
: 別人往往會讀 .h檔裡面的注解, 說明.
: 個人常常被念說, 說明寫不清楚.
: 請問有沒有人寫過類似的說明, 註解,
: 或者有沒有經典的範例呢?
真實正義你可以學一下 doxygen 怎麼用，
這是一種讓你在程式碼裡面以註解的形式撰寫文件的工具。
致於良好的文件寫出來應該是什麼樣子？請看這邊：
http://doc.qt.nokia.com/4.7/qcombobox.html
這個網頁不是人另外去寫的，而是從原始碼的註解直接生成的，
每一個函數的用途、用意、用法都有詳細說明，
函數的每一個參數是什麼意思也有說明，
如果你也寫到這樣的話那就不錯了。
--
To iterate is human, to recurse, divine.
遞迴只應天上有, 凡人該當用迴圈. L. Peter Deutsch
--
※ 發信站: 批踢踢實業坊(ptt.cc)
◆ From: 203.160.254.105
討論串 (同標題文章)