根據(jù)“Effective Go” golang.org/doc/effective_go程序中的每個導出(大寫)名稱都應該有一個文檔注釋。假設我在一個簡單的 Web 應用程序上有一個視圖處理程序// Handle the front page of the websitefunc FrontPageView(w http.ResponseWriter, r *http.Request) { controllers.RenderBasicPage(w, "frontPage") }我的問題是:那個 godoc真的有必要嗎?也許我現(xiàn)在只是喜歡 Robert Martin 的 Clean Code,但它似乎是一個有效命名的變量,在這種情況下FrontPageView不需要這樣的 godoc。這可能是“是否需要 javadoc?”的衍生/重復。或“python 文檔字符串是否必要?”,但我確實想確保在學習一門新語言時,我堅持使用特定于語言的規(guī)范做事方式。
- 0 回答
- 0 關注
- 188 瀏覽
添加回答
舉報
0/150
提交
取消