俺コーディングポリシー
の編集
Top
/
俺コーディングポリシー
[
トップ
] [
編集
|
凍結
|
差分
|
添付
|
リロード
] [
新規
|
一覧
|
検索
|
最終更新
|
ヘルプ
]
Active
Rubyチートシート
成果物リスト
勉強会ログ
↑
アイデア
Webサービス案
Androidアプリ案
電子工作案
GreaseMonkey案
contribute
編集
↑
Recent
2023-11-12
自動車保険
2023-08-04
HDDリスト
2023-08-03
docker
2023-05-17
Rubyチートシート
2023-03-30
RAID5/トラブル20230324
2023-03-25
PC/misuzu
2023-03-24
PC
2023-03-23
PC/DESKTOP-7SL5J8R
2022-12-16
Linux
2022-11-09
Linux/ディスクイメージ取得
2021-05-23
CTF
2021-03-17
PC/misumi
2020-08-31
COMP
2020-03-28
PC/misumi/ubuntu
Windows 10
2018-06-04
Microsoft decode 2018 2日目
Microsoft decode 2018 1日目
2018-04-07
カメラ
2018-01-06
電力自由化
2017-12-21
CROSS×BEATS
B
I
U
D
H
[[]]
<br>
--
*コメント 書くべきは、意図・要約・理由・言い訳。 コメントがなくても読めるコードが理想。 よくないコードを見たら、フォローするコメントを書くよりリファクタしたほうがいい。 日本語で挙動を表現するのはそもそも難しい。日本語に悩む時間があったら、コードをわかりやすくするのに使った方がいい。 次のようなコメントは書かない。 -言語の常識レベルの機能の説明 --「コンストラクタ」・「デストラクタ」 --「インクルード」・「関数宣言」・「関数定義」 --などなど -DRY原則違反のもの --クラス名、メソッド名、変数名を日本語訳・カタカナ表記しただけ --処理の内容をほぼ1対1で記述 --メソッドのコメントに、そのメソッドの名前を含める ---クラス・ファイルも同様 --基底クラスのコメントを、派生クラスにコピペ ---派生クラス特有の内容があれば、それだけを書く。 --罫線 ---ハイフンのコピペなので、DRY原則違反(半分冗談) 上記のようなことしか書くことがなかったら、何も書かなくていい。 すべての関数や引数にコメントをつけろ、というルールは、無意味なコメントを書くことを強制するのでよくない。 すべてにコメントをつけると統一感はあるけど、特に実益はないと思う。 それより、コメントを書くコストと、ノイズによってコードが読みにくくなることを重く見たほうがいい。 リファレンスマニュアルを自動生成する場合は、公開関数にコメントを義務づけるのはしかたないかも。 それはコードではなくドキュメントを書くコストと見なしていい。
タイムスタンプを更新
テキスト整形のルールを表示する
Last-modified: 2014-12-24(水) 16:49:52