内容紹介
ソフトウェアの実装品質向上へ!コーディング規約策定への指針
本書は、プログラムの書き方を一定の規約としてまとめるためのポイントをまとめたものである。開発スタッフで規約を共有することにより、読みやすくバグの少ないコーディングが可能となり、開発効率のアップや品質向上をもたらすことができる。全ソフトウェア開発者は、一見の価値がある書である。
目次
主要目次
Part1 コーディング作法ガイドの読み方
1 概要
2 ソースコード品質のとらえ方
3 本ガイドの利用方法
Part2 組込みソフトウェア向けコーディング作法:作法表
●作法表の読み方
●作法表中の用語
●組込みソフトウェア向けコーディング作法
信頼性R1
信頼性R2
信頼性R3
保守性M1
保守性M2
保守性M3
保守性M4
保守性M5
移植性P1
移植性P2
効率性E1
付録 作法・ルール一覧
詳細目次
Part 1コーディング作法ガイドの読み方
1 概要
1.1 C++言語版のコーディング作法について(本書の読み方)
1.2 コーディング作法とは
・コーディング規約に関する課題点
・コーディング作法とは
1.3 コーディング作法の目的と位置付け・想定利用者
・コーディング作法の目的と位置付け
・想定する利用者
・得られる効果
1.4 コーディング作法の特徴
・体系化された作法・ルール
・すぐ使えるリファレンスルール
・ルールの必要性を提示
・他のコーディング規約との対応関係を明示
1.5 本ガイド利用に関する注意事項
・ルールの範囲
・本ガイドで参照している規格、参考文献類について
C90/C99/C++/Joint Strike Fighter Air Vehicle C++ Coding Standards for the System Development and Demonstration Program/Effective C++/More Effective C++/C++ Coding Standard/GNU Coding Standards/MISRA-C、MISRA-C++/MISRA-C:1998/MISRA-C:2004/MISRA-C++:2008
2 ソースコード品質のとらえ方
2.1 品質特性
・JIS X 0129とソースコードの品質
2.2 品質特性と作法・ルールの考え方
・全体構造
作法/ルール/作法とルールの対応付け
3 本ガイドの利用方法
3.1 本ガイドの利用シーン
新規コーディング規約の作成/既存コーディング規約の充実/プログラマの研修、独習のための学習教材
3.2 新規コーディング規約の作成
・作成時期
・作成方法
Step-1 コーディング規約の作成方針を決定
Step-2 決定した作成方針に沿ってルールを選択
Step-3 ルールのプロジェクト依存部分を定義
Step-4 ルール適用除外の手順を決定
3.3 既存コーディング規約の充実
・抜けモレの防止
・ルール必要性の明確化
3.4 プログラマの研修・独習のための学習教材
・対象者
・学習出来ること
Part 2組込みソフトウェア向けコーディング作法:作法表
作法表の読み方/C言語版との違いについて/作法表中の用語
●信頼性
信頼性R1 領域は初期化し、大きさに気を付けて使用する。
信頼性R2 データは、範囲・大きさ・内部表現に気を付けて使用する。
信頼性R3 動作が保証された書き方にする。
●保守性
保守性M1 他人が読むことを意識する。
保守性M2 修正し間違えないような書き方にする。
保守性M3 プログラムはシンプルに書く。
保守性M4 統一した書き方にする。
保守性M5 試験しやすい書き方にする。
●移植性
移植性P1 コンパイラに依存しない書き方にする。
移植性P2 移植性に問題のあるコードは局所化する。
●効率性
効率性E1 資源や時間の効率を考慮した書き方にする。
付録 作法・ルール一覧
作法詳細、MISRA-C/MISRA-C++ルールとの関係
参考文献
続きを見る