Go公式WikiのCommentsの日本語意訳になります。
(元記事の最終更新日: 2014/12/11 rev.2)
コメントに関する最低限の説明が記述されています。
コメント
全てのパッケージにはパッケージコメントがあるべきでしょう。パッケージコメントはパッケージ内の1つのファイル内のpackage
文の直前に置かれる必要があります。(パッケージコメントは1つのファイルにだけ必要です。)
コメントは “Package パッケージ名” から始まる単一の文で始め、パッケージの機能について簡潔な要約を記述します。この概要紹介文はgodocの全パッケージのリストとして使われます。
後に続くの文章や段落は、より詳細に記述することができます。文章には適切な句読点が必要です。
// Package superman は世界を救うためのメソッドを実装しています。
//
// 経験からいって、少ない手続きは世界を救うために役立つことが証明されています。
package superman
ほぼ全てのトップレベルの型、定数 const
, 変数 var
, そして 関数 func
にはコメントをつけるべきです。
bar
に対するコメントは “bar は谷と丘の上に浮かぶ” のような形式にする必要があります。
bar
の最初の文字はコード上で大文字になっていない限り、大文字にしてはいけません。
// enterOrbit は惑星の救済の可能性を提供する低地球周回軌道へと、
// スーパーマンを飛び立たせます。
func enterOrbit() os.Error {
...
}
comments powered by Disqus