MIRS9703 ソフトウェア開発規約

Written by Haruki Iwata.
Revised by Haruki Iwata.(2nd Edition)


モジュール/データ名称およびコード番号の規定

モジュール名称は後ろにそれぞれ、『−モジュール』をつけて明らかにしておく。
ただし、データ名称については『−データ』とする必要はない。
コード番号は、
モジュール番号は『(タスクナンバ)−INZorNRMorTIMorINT』、
データ番号は『(タスクナンバ)−(BBナンバ)』
とする。

プログラミング書法の規定

ヘッダー部
以下の内容について記載する。
  • プログラム名
  • プログラムの内容
  • プログラムのバージョン(Ver. 上位バージョン.下位バージョン)
  • プログラムの作成日付
  • プログラムの変更日付
  • プログラムの変更点
  • その他特記事項

関数名
各モジュール内のみの関数
 書式:(関数名称)_(モジュール番号)()
 * 共通で用いる独自の関数が存在しないので強制はしない。
共通の関数
 書式:(関数名称)()

関数本体
TABを用い、for文・if文などのかたまりをインデントし、どこから始まってどこで終わっているのかを明瞭にし、
意味上の固まりで一行空行を挿入するなど見た目のわかりやすさを優先する。

コメント
必要に応じて作成者以外にプログラムの意味を分かりやすくするため、コメントをつける。
関数やプログラム全体を簡単に説明する場合は『/*』のあとに改行を加えてから書き始め、最後の次の行で『*/』で完結する。
プログラム1行の場合は、TABのあとに続けて『/*』と『*/』の間に日本語でコメントをつける。

内部変数の定義
内部変数は、プログラム製作者に一任する。但し必要があれば内部変数の説明の為にコメントを加える。

FD管理規定

基本的にデータの監理は学内ネットワークディスクサーバ内で行い、
FDは移動、バックアップ等に各自が適宜利用する。
ソース及び関連する資料等MIRSソフトウェアに関する全てのファイルを、
データ損失防止のため、各自のFDもしくはPCのHD内に保存する。
特に各自が各々最も関わっている部分については責任を持って管理する。
又、マスターデータ以外にバックアップデータを用意する。

変更管理規定

ファイル変更の際は、必要なマスタ−ディスク中のファイルを作業用ディスクにコピ−したものを使い、変更作業終了後、変更したファイルをマスタ−ディスクにコピ−する。
過去のバージョンのファイルも必要に応じて、特に大きな変更の前のファイルを変更者がバックアップしておく。
過去のバージョンのファイルはそのヘッダー部にその旨を書くとともにファイル名を、
Filename.X1X2X3
とする。
ファイルのバージョンは、基本的にver.1.01から始める。
但し、中途半端なものについてはver0.xから初めても構わない。
大規模の変更の際、上位バージョンを1上げ下位バージョンを1に戻す。
小規模の変更の際、下位バージョンを1上げる。
という様にバージョンを更新する。
但し、小規模のバージョン更新の中でも比較的変更が多い場合には、10の桁を増やすなどメリハリを出す。


< Back