改了一個標題

把標題給改了:{**@author(magicgod)}。這個標題的意思是delphi中的註釋,@author就是類似javadoc的標籤,{**這個開頭就是表示內部標籤有效,否則是無效的。這種標籤由pasdoc支持解析,可以生成api文檔。


將代碼中的信息提出理解成設計文檔是不錯的思路,不過還沒看到好的解決方案,簡單地註釋當然不能代替設計文檔了。從信息量上講是沒問題了,就是在分離和轉換方面需要做進一步的工作,希望以後有好的工具可以從代碼中生成設計文檔。


www.kicoy.com
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章