Commit 6095ff38 authored by Rob Pike's avatar Rob Pike

Effective Go: stress that comments are uninterpreted text

that should look in godoc.

R=rsc, dsymonds
CC=golang-dev
https://golang.org/cl/4192041
parent eb868815
...@@ -194,9 +194,13 @@ Comments do not need extra formatting such as banners of stars. ...@@ -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 The generated output may not even be presented in a fixed-width font, so don't depend
on spacing for alignment&mdash;<code>godoc</code>, like <code>gofmt</code>, on spacing for alignment&mdash;<code>godoc</code>, like <code>gofmt</code>,
takes care of that. 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 annotations such as <code>_this_</code> will reproduce <i>verbatim</i> and should
not be used. 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>
<p> <p>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment