mirror of
https://github.com/golang/go.git
synced 2025-05-05 15:43:04 +00:00
Comments: syntax highlighting
parent
4d6a1bf126
commit
814c219bae
@ -4,7 +4,7 @@ Every package should have a package comment. It should immediately precede the `
|
||||
|
||||
Subsequent sentences and/or paragraphs can give more details. Sentences should be properly punctuated.
|
||||
|
||||
```
|
||||
```go
|
||||
// Package superman implements methods for saving the world.
|
||||
//
|
||||
// Experience has shown that a small number of procedures can prove
|
||||
@ -14,7 +14,7 @@ package superman
|
||||
|
||||
Nearly every top-level type, const, var and func should have a comment. A comment for bar should be in the form "_bar_ floats on high o'er vales and hills.". The first letter of _bar_ should not be capitalized unless it's capitalized in the code.
|
||||
|
||||
```
|
||||
```go
|
||||
// enterOrbit causes Superman to fly into low Earth orbit, a position
|
||||
// that presents several possibilities for planet salvation.
|
||||
func enterOrbit() os.Error {
|
||||
|
Loading…
x
Reference in New Issue
Block a user