コーディング規約 トップページ


 

〜 VB、VC++、C#、Java、Access、Excel対応 〜
そのまま使えるコーディング規約集

●システム 仕様書(プログラム 設計書) 自動 作成 ツール 【A HotDocument】情報

本サイトのシステム 仕様書(プログラム 設計書)は、全てシステム 仕様書(プログラム 設計書) 自動 作成 ツール 【A HotDocument】にて自動生成しました。
【A HotDocument】とは、システム開発時におけるドキュメント作成を完全自動化する開発支援ツールです。
VB、VC++、C#、C#Builder、J#、Java、C++Builder、Access、Excelのファイルからクリック一つで、納品、保守用の美しいドキュメントを瞬時に、Excelファイル/テキストファイルへ自動生成します。
また、プログラム作成時に必要な、html/chm/xml形式の仕様書出力も可能になりました。
詳細は、【A HotDocument】製品ページをご覧ください。
システム 仕様書(プログラム 設計書) 自動 作成 ツール 【A HotDocument】

●コーディング規約 - 文書としてのソースファイル  
コーディング規約に従ってソースファイルを記述することは、慣れないと大変面倒です。
しかし、コーディング規約を決めた場合と決めない場合のデバッグ効率を比較したところ、決めた方が30%も効率アップしたという事例があります。それは、全て違う形式で書かれた文書と統一形式で書かれた文書を読んで、そして理解する差と同じです。
ソースファイルも実は、人間が読んで理解するための文書です。
その文書を複数の人が記述するためには、それなりのルールが必要です。

昨今では、企業システムがますます複雑化するなかで、開発対象となるシステムの種類や局面に応じて、多様な開発ツールや言語を使い分けるといったケースも増えています。
そのため、開発ツール/言語を問わず、統一感のある洗練されたコーディング規約が必要になっています。

●そのまま使えるコーディング規約集の有効な活用方法  
そこで本サイトは、プログラム開発時に不可欠となるVB、VC++、C#、Java、Access、Excelの各種プログラム言語のコーディング規約を公開しました。
このコーディング規約は、数百のシステム開発で実際に使われた規約を元に、独自に良い部分のみを抜き出してまとめました。

Visual Studio .NET/2005/2008環境におけるVisual BasicやVisual C++、Visual C#やVisual J#をはじめ、Access、Excel、さらにはJavaに至るまで、今日のシステム開発に用いられている広範な開発ツール/言語に幅広く対応しています。
もちろんプログラム言語を問わず、無駄の無い、統一感のある洗練された内容になっています。
また、全てhtml形式になっておりますので、必要に応じて、加工、編集してご自由にお使いいただけます。

プログラムを作る、全ての作業の効率化になれば幸いです。

Visual Basic コーディング規約


●C/C++ コーディング規約


●C# コーディング規約


●Access/Excel/VBA コーディング規約


●Java コーディング規約

◆各言語のコーディング規約

各言語の簡単なコーディング記述例は下記の通りです。
詳細は、上記のコーディング規約の詳細ページをご確認ください。
VB 2005/VB 2008/Visual C#版は、XMLコメントにも対応しております。

◆VB/Access-VBA/Excel-VBA
  Private Structure SYMBOLINFO ' 宣言文字構造
    Dim SyDataType As String     ' As宣言文字列
    Dim SyDataTypeDef As String   ' 型宣言文字
  End Structure
  Public Const APPNAME = "HotDoc"   ' アプリケーション名
  Public gTMPDIR As String         ' テンポラリディレクトリ名

  '
  ' 機能:   メッセージ文字列の取得
  '
  ' 返り値:  メッセージ文字列
  '
  ' 機能説明: メッセージ定義ファイルより指定されたメッセージ
  '       を取得する
  '
  ' 備考:   返り値の文字列の最大文字数は80文字
  '
  Private Function GetMsg(FileNum As Integer, Index As Index) As String
    '' 処理のコメント
  End Function 

◆Visual C++/ANSI-C
  #define HC_MAX_PATH    128   // フルパス 最大文字列数
  #define NUMBER_OF(a) \
            ( sizeof(a) / sizeof(a[0]) )  // 配列の要素数を得る

  typedef struct Memory {  // メモリ上のバッファ
    char *s;           // 文字列
    struct Memory *next;   // リスト構造ポインタ
  } MEMORY;

  //
  // 機能 : 文字位置の取得
  //
  // 返り値 : 文字位置[byte](検索されなかった場合は 0を返す)
  //
  // 機能説明 : 文字列の中から,指定文字列を検索し位置を返す。
  //
  // 備考 : pStrInStr( "a#c#d#eeee", "#" ) -> 2
  //     pStrInStr( "a#c#d##eeee", "##" ) -> 6
  //     pStrInStr( "abcdeabcde", "AA" ) -> 0
  //
  int pStrInStr(const char *tarstr, // 検索される対象の文字列
           const char *srcstr) // 検索する指定部分文字列
  {
    /// 処理のコメント
  }

◆Visual C#/Java
  public const int LOOP_COUNT = 2; // ループの数
  public static int nSize = 10;      // ボタンのサイズ

  //
  // 機能 : ボタンをクリックされた時の処理
  //
  // 機能説明 : ボタンをクリックされた時の処理を行う。
  //        クラス定数LOOP_COUNT回、ダイアログを表示する。
  //
  // 返り値 : なし
  //
  // 備考 : 簡単なサンプルです。
  //
  private void button1_Click (Object sender, System.EventArgs e)
  {
    /// 処理のコメント
  }