url: http://www13.atpages.jp/t6s5/docs/r-style-guide-j.html
snippet:
-----引用-----
TODOの書式 :
コード全体を通して TODO の書式を一貫させる.
TODO(ユーザ名): 予定の行動の明確な記述
常識を使うことと一貫性を持つこと :
もしコードを編集するなら, その周辺のコードを しばらく眺めてから, その書式を決めること. もし編集しているコードが if 節の前後に 空白を入れているなら, あなたもそれにならうこと. もし, 編集しているコードは注釈がアスタリスクの四角形で囲まれているなら, 新たに加える注釈もアスタリスクの四角形で囲うこと.
書き方のガイドラインを持つ意義は, コード書きの共通語彙を持つことで, どうやって書くかに悩まされることなく何を書きたいかに 集中できることにあります. 広く使われている書き方の規則をここに示したので, その共通語彙はわかるでしょう. しかし, 一部の グループで使われている書き方も重要です. もし, あるファイルに加えようとするコードが 既存のコードから極端に異なっているなら, その不連続性により, そのコードを読もうとするひとを コードの流れの外へと追い出してしまうでしょう. これを避けるよう努力すること.
-----引用-----
0 件のコメント:
コメントを投稿