MIRS9703 ソフトウェア開発規約

Written by Haruki Iwata.


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

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

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

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

関数名
各モジュール内のみの関数
書式:(関数名称)_(モジュール番号)()
共通の関数
書式:(関数名称)()

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

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

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

FD管理規定

MIRSソフトウェアに関する全てのファイルをマスターディスクに保存する。
データ損失防止のため、マスターディスク以外にバックアップディスクを用意する。
個人用の作業用FDを別に用意しておく。

変更管理規定

ファイル変更の際は、必要なマスタ−ディスク中のファイルを作業用ディスクにコピ−したものを使い、変更作業終了後、変更したファイルをマスタ−ディスクにコピ−する。
変更後も過去のバージョンのファイルを保存しておく。
過去のバージョンのファイルはそのヘッダー部にその旨を書くとともにファイル名を、
Filename_X1X2X3.拡張子
とする。
但し、初期バージョンはv1.01とし以降、
大規模の変更の際、上位バージョンを1上げ下位バージョンを1に戻す。
小規模の変更の際、下位バージョンを1上げる。
の様にバージョンを上げていく。


< Back