2018/08/23 Shell Style Guide 2 - Githubissues

aloerina01 / til

1日１つだけ強くなる

6 stars 0 forks source link

2018/08/23 Shell Style Guide 2 #47

Open aloerina01 opened 6 years ago

aloerina01 commented 6 years ago

Comments

File Header

そのスクリプトの概要を必ず書きましょう
著作権表示はオプションで

Functional Comments

処理の複雑さ、簡潔さなどに関係なく、コメントはつけるべきです
- 機能の説明
- グローバル変数の説明
- 引数やオプションの説明
- 返り値やデフォルト値の説明など

実装上のComments

Googleの一般的な規則に沿ってかく

TODO Comments

一時的な対処策、最適な方法でないコードにはTODOコメントを添えます

aloerina01 commented 6 years ago

次回はここから