is there some rules to document methods and variables in GO language?
for example on php
/**
This method will increase parameter $b in 10 points
@var int $b
@return int
*/
public function someMethod($b){
return $b+10;
}
is there something like that on GO, or there I must use only "// comment" above method without any @var or @return ?
You should use standard // comments because this is what the official documentation tool called godoc will use to generate documentation for your go code. You can have a look at this post from the official golang blog about it: http://blog.golang.org/godoc-documenting-go-code
I also found this quite interesting: https://godoc.org/github.com/natefinch/godocgo
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With