Re: [問題] class 的使用說明
※ 引述《RealJustice (19非崇貞,最多是袁紹)》之銘言：
: 自己寫出來的class,
: 想讓別人使用時,
: 別人往往會讀 .h檔裡面的注解, 說明.
: 個人常常被念說, 說明寫不清楚.
: 請問有沒有人寫過類似的說明, 註解,
: 或者有沒有經典的範例呢?
敝人覺得可以直接用 VAX 裡面的 pre-function comment 當參考
最直接的方式還是寫一份 sample code 出來
下面這份 code 是小弟寫 KMeans Algorithm,
寫得很不漂亮，完全沒用到 template，
甚至也沒什麼 OO 概念，class 實做程式碼請恕拿掉，但註解保留。
( 因為寫得很醜，不敢見人，加上學術研究尚未成形發表，
只是研究需求趕著 coding 一份，故恕實體程式碼暫不公開)
可能小弟自我要求沒那麼高 (也可能還沒 teamwork 經驗)
敝人認為如果從 sample code、註解看得出來這 class 怎麼用，
那這份 Class 說明 "應" 算尚可接受，
若撰寫或註解上有不妥之處，也請各位版友不吝指正。
http://nopaste.csie.org/55384 -> EdisonXKMeans.h
http://nopaste.csie.org/d8626 -> EdisonXKMeans.cpp
http://nopaste.csie.org/3c35e -> EdisonXKMeansTestMain.cpp
--
YouLoveMe() ? LetItBe() : LetMeFree();
--
※ 發信站: 批踢踢實業坊(ptt.cc)
◆ From: 180.177.76.142
討論串 (同標題文章)