阅读 godoc 文档,它没有说明如何记录函数参数。
为什么会省略这个?
godoc中没有对函数参数进行明确的文档说明。任何名称和类型未涵盖的必要细节都应该写在函数的文档注释中。例如,请参见标准库中的每个函数。
// splitExampleName attempts to split example name s at index i,
// and reports if that produces a valid split. The suffix may be
// absent. Otherwise, it must start with a lower-case letter and
// be preceded by '_'.
//
// One of i == len(s) or s[i] == '_' must be true.
func splitExampleName(s string, i int) (prefix, suffix string, ok bool) {
if i == len(s) {
return s, "", true
}
if i == len(s)-1 {
return "", "", false
}
prefix, suffix = s[:i], s[i+1:]
return prefix, suffix, isExampleSuffix(suffix)
}
s
和i
,包含在函数前的摘要描述中。同样,有关返回值的注释也包括在该段落中。这与Java或Python或其他语言不同,它们为这些详细信息提供了更正式的结构。这是因为Golang风格通常针对简洁和灵活性进行优化,避免了其他语言的指导性风格,并依赖于gofmt
来完成大部分重型工作。s
或i
,自动重命名文档中的引用并不起作用(例如在IntelliJ中)。 - Ustaman Sangat