2005年05月14日

Code Reading 第7章

この章は非常に短い。coding standardの採用の必要性と、主なcoding standardsはどのような点について推奨基準を定めているかの説明。

7.1 ソースコードに含まれる一般的な文書ファイルのファイル名とその説明

README, INSTALL, TODOなど。

7.2 Indentation

特になし。

7.3 Formatting

不揃いなフォーマッティングはバグの元。
コメントのフォーマットでは、/*- で始まる場合はアスキーアートによる図解など再整形されたくない内容を示す。Javalでは、/**で始まるものはjavadocにより処理される。
switch文でコードを書いた意図を表明する/* FALL THROUGH */と/* NOTREACHED */。

コメント中のXXX, FIXME, TODOの用法:

  • XXX: その部分のコードが正しくないが多くの場合動いてしまう
  • FIXME: コードが間違っていて修正を要する
  • TODO: 将来強化すべき箇所の表示

7.4 Naming Conventions

英文字の大小やアンダースコアによるBSD, Java, Windowsの命名規則を紹介。 名前を構成する規則や語彙などについての話はなかった。

7.5 Programming Practices

portabilityのためにコードの書き方をルール化。GNUは16bit環境を考えていないなど暗黙的な仮定があることに注意。
ユーザインタフェースやその処理方法も標準化。(コマンドライン引数の処理や、GUIアプリケーションのUIガイドライン)

7.6 Process Standards

多くのcoding guidelineはコードだけでなく文書やビルドプロセスにも標準化の範囲を広げている。(例: UNIXのman、GNUのtexinfo、BSDのソースツリーのMakefile)

主なcoding standards:

この記事へのトラックバックURL
http://blog.seesaa.jp/tb/3625720
※言及リンクのないトラックバックは受信されません。

この記事へのトラックバック
この記事へのコメント
コメントを書く
お名前: [必須入力]

メールアドレス:

ホームページアドレス:

コメント: [必須入力]

認証コード: [必須入力]


※画像の中の文字を半角で入力してください。

広告


この広告は60日以上更新がないブログに表示がされております。

以下のいずれかの方法で非表示にすることが可能です。

・記事の投稿、編集をおこなう
・マイブログの【設定】 > 【広告設定】 より、「60日間更新が無い場合」 の 「広告を表示しない」にチェックを入れて保存する。


×

この広告は1年以上新しい記事の投稿がないブログに表示されております。