4
我從來沒有爲任何C風格的代碼編寫過文檔（只做過asdoc和phpdoc）。我一直在尋找Doxygen來記錄我的Objective-C代碼，但我不確定在哪裏發表評論。我應該記錄.h文件還是應該將註釋添加到.m文件？或兩者？還有其他建議嗎？在哪裏用Doxygen編寫代碼
A
回答
4
根據約定一個更深入的例子中，註釋是要放置在頭文件（* .h）中，因爲它們大多含有聲明和它們更容易閱讀。
當沒有關聯的頭文件時，源文件（* .m）中的文檔非常有用：例如，當您爲某個類使用專用類別時。
此外，Doxygen有一些選項可以打印一些警告，如果有些東西沒有或沒有足夠的文件。
編輯：
這裏有一個叫做Documenting Objective-C with Doxygen教程的鏈接。
1
看看一些項目的doxygen文檔，看看他們做了什麼。
http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/給我留下了深刻印象，但我相信你可以找到一個能夠很好地工作的Objective-C項目。
API文檔進入.h文件。你可能有一些值得記錄的實現細節，所以你在.m文件中也會有一些。只是不要重複自己。
避免重複你的代碼已經說過的話。
2
你的意見一般屬於.h文件，因爲這些是人們看待如何使用你的類。
Here是如何使用的Doxygen特異性地與目標C
相關問題
- 1. Laravel 5.4哪裏寫javascript代碼？
- 2. 此代碼錯在哪裏
- 3. 代碼錯誤在哪裏
- 4. libOAuth.a源代碼在哪裏？
- 5. 補丁代碼在哪裏？
- 6. 我在哪裏可以在線瀏覽libc的源代碼（如doxygen）
- 7. doxygen評論在哪裏適合/必要？
- 8. C++：在哪裏編寫代碼文檔：在.cpp或.hpp文件中？
- 9. 哪裏可以在iPhone中編寫在UITableViewCell中繪製正方形的代碼
- 10. Vs2010代理，代碼在哪裏
- 11. 從Windows源代碼編譯Doxygen
- 12. 在哪裏寫最後的（else語句）在這個python代碼？
- 13. PHP：Zend_Layout：在哪裏編寫業務邏輯？
- 14. 我在哪裏編寫和鏈接jQuery？
- 15. 我應該在哪裏編寫我的Flash遊戲循環的代碼？
- 16. 在哪裏位置argparse在代碼
- 17. 硬編碼值存儲在哪裏？
- 18. 在哪裏編碼啓發式？
- 19. 我可以在哪裏編譯我的ruby代碼？
- 20. java編譯器的源代碼在哪裏？
- 21. 緩存.NET JIT編譯代碼在哪裏？
- 22. Xamarin Android來編輯axml。在哪裏切換設計/代碼？
- 23. 我在哪裏編輯科爾多瓦的插件Java代碼？
- 24. 我在哪裏可以找到「經典」ASP代碼編輯器？
- 25. WMD編輯器：我在哪裏可以獲取代碼？
- 26. 計算器展示代碼在哪裏？
- 27. Rails：Nokogiri問題，在哪裏放置代碼。
- 28. 我應該在哪裏放AutoLayout代碼？
- 29. 在哪裏放置日誌代碼
- 30. 碰撞檢測代碼在哪裏？