課題提出前のチェックリスト - よくある質問 - Top
以下はより良いコードのための指針です.ここまで習ったことですべてが達成できるわけではありません.
課題の読み方 †
- 課題を読み,要求について理解した.
- 課題に不備を感じた場合,質問した.
- 初期状態について考えた.
- 境界条件について考えた.
設計 †
- 適切なクラスを定義した.
- 適切な型で変数を定義した.
- 不要なクラス・メソッド・変数が存在しない.
- マジックナンバーが存在しない.
- 適切に名前をつけ,定数に置き換えている.
- 各課題で要求されている設計を満たしている.
- 「extends WindowController」の不要なクラスでこれを使用していない.
- 同じコードを繰り返して書いていない. (メソッド,再帰,配列,ループを学習した後)
レイアウト †
- インデント(行頭の字下げ)が正しく行われている.(BlueJのAuto-Layoutを活用しましょう)
- 無駄な過剰な空行が存在しない.
- 行末に無駄なスペースがない.
- 名前が適切である.(Bad: hoge, a, data) (Good: topLine, bodyX, offset)
- 変数名の初めが小文字である.(例: cuteFace)
- クラス名の初めが大文字である.(例: RisingFunny)
- 適切なコメントが書かれている.
- 不要なコードがコメントアウトではなく,削除されている.
- 1行が100文字を超えていない.
プログラムの検証 †
- 提出するすべてのファイルのコンパイルが成功する.
- 実行時エラーが出ていない.
- 異なる初期状態や境界条件でも適切に動く.
レポート(README.TXT) †
- 各課題でレポートに書くことが要求されていることをレポートに書いた.
- 実装の上で工夫したことをレポートに書いた.
- 課題に解釈の余地がある場合,どのように解釈したかレポートに書いた.
- 言葉遣いが適切である.
- レポートだけを読んで理解できる文章を書いた.
提出後の注意 †
- 採点結果についてのメールがgithubから送られてくることがあります.確認するようにしてください.