根据“Effective Go” golang.org/doc/effective_go
程序中的每个导出(大写)名称都应该有一个文档注释。
假设我在一个简单的 Web 应用程序上有一个视图处理程序
// Handle the front page of the website
func FrontPageView(w http.ResponseWriter, r *http.Request) {
controllers.RenderBasicPage(w, "frontPage")
}
我的问题是:那个 godoc真的有必要吗?也许我现在只是喜欢 Robert Martin 的 Clean Code,但它似乎是一个有效命名的变量,在这种情况下FrontPageView不需要这样的 godoc。这可能是“是否需要 javadoc?”的衍生/重复。或“python 文档字符串是否必要?”,但我确实想确保在学习一门新语言时,我坚持使用特定于语言的规范做事方式。
相关分类