mirror of
https://github.com/golang/go
synced 2024-11-12 04:50:21 -07:00
Effective Go: stress that comments are uninterpreted text
that should look in godoc. R=rsc, dsymonds CC=golang-dev https://golang.org/cl/4192041
This commit is contained in:
parent
eb8688154b
commit
6095ff3864
@ -194,9 +194,13 @@ Comments do not need extra formatting such as banners of stars.
|
||||
The generated output may not even be presented in a fixed-width font, so don't depend
|
||||
on spacing for alignment—<code>godoc</code>, like <code>gofmt</code>,
|
||||
takes care of that.
|
||||
Finally, the comments are uninterpreted plain text, so HTML and other
|
||||
The comments are uninterpreted plain text, so HTML and other
|
||||
annotations such as <code>_this_</code> will reproduce <i>verbatim</i> and should
|
||||
not be used.
|
||||
Depending on the context, <code>godoc</code> might not even
|
||||
reformat comments, so make sure they look good straight up:
|
||||
use correct spelling, punctuation, and sentence structure,
|
||||
fold long lines, and so on.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
|
Loading…
Reference in New Issue
Block a user