ちょっと前に記事で書いていたUnityはいろいろあってとりあえず凍結しました.
勉強会の内容は
タイトル | 内容 |
---|---|
綺麗なコードの定義,説明 | インデント,空行,並び順,名前,コメントを駆使した見た目の重要性の説明 |
グループ活動 | 見たくもないクソコードをグループで解析してどこがゴミかを発表 |
まとめ | グループ活動で発表したクソコードの問題点のまとめ.資料のススメ |
という感じでした.
今回学習した要点まとめ
- 本来コードとは小説のようにすらすらと読めるものである
- 人間はブロックで理解するのでソースコードをブロックに分けて書くことが大切
- 空行を入れる
- メソッドが長い場合(目安としては50行以上),別のメソッドを用意して処理を移す.
- インデントを正そう()
- JSで言うと「JSLint,JSHint,ESLint」などのコードチェックツールをいれましょうねー^^
- 公開度の高い順に並べましょう(上からpublic->なし->protected->private)
- メソッドは動詞で書くようにする
TODO:
,FIXME:
,OPTIMIZE:
,HACK:
,REVIEW:
などのアノテーションコメントを活用する- コメントは常に正しくメンテナンスしよう
- 正しくないコメントは無い方が良い
- BeautifulCode買っとけ
- Readableodeも買っとけ
アクセス修飾子の種類(忘れるのでメモ)
種類 | 説明 |
---|---|
public | 全てのクラスからアクセス可能 |
protected | 同じクラス内、同じパッケージ、サブクラスからアクセス可能 |
なし | 同じクラス内、同じパッケージからアクセス可能 |
private | 同じクラス内のみアクセス可能 |
(http://www.gamesite8.com/archives/588322.html より)
汚ソースを見て思ったこと(他グループ含む)
- 1クラスに対して量が多い
- メソッド名関係
- 名前が長い(1画面に収まりきらなくなっている)
- 意味がわからん
- 日本語と英語を混ぜるな(getGoukeiMoney)
- コメント関係
- 引数の説明が無い
- docの表記に合わせる
- コメントに嘘混在
- 変数名でわかるのにコメントが有る
- e.g.)String Myname; // ぼくのなまえ!!
- returnで返せる場合は先に返す(これはリーダブルコードに書いてあったのを俺が適当に言っただけだからこの汚ソースにはなかったかも)
- foreachのネストにforeach ▂▅▇█▓▒░(’ω’)░▒▓█▇▅▂うわあああああああ
- 否定文をできるだけ肯定文にして書く
- 三項演算子は単純なときのみ使用
- (個人的に使うなは言い過ぎ)
- 引数が多い場合は配列に入れて渡す
- 無駄space
- spaceと空行の混在
- メソッド名と内容の不一致
- 引数で渡されていて,使われていないものがある
- マジックナンバー多い
他のグループの意見も入れるとこのぐらい上がりました.以上から論外を抜くと自分がやっちゃいそうなことを抽出すると
- メソッド名関係
- 意味がわからん
- コメント関係
- docの表記に合わせる
- foreachのネストにforeach
- 否定文をできるだけ肯定文にして書く
- 引数が多い場合は配列に入れて渡す
- 無駄space
- spaceと空行の混在
- メソッド名と内容の不一致
マジックナンバーとはなんじゃらほい
マジック・ナンバーとは,ソース内に埋め込まれた,プログラマ本人にしか意味が分からない数値のこと
(http://itpro.nikkeibp.co.jp/article/COLUMN/20070820/279836/ より)
_BkってのがあってBackの略(裏方の処理用らしい)って言われたけど,まじで意味不明だった.Bk201しかでてこない...
0 コメント:
コメントを投稿