【A HotDocument】 トップ

>

コメント規約(コーディング規約)


コメント規約(コーディング規約)
ドキュメント自動生成ツール【A HotDocument】

【A HotDocument】のコメント規約(コーディング規約)のダウンロードの方法を説明します。
コメント規約(コーディング規約)は、VB、VC++、C#、Java、Access、Excelの全ての言語に対応しております。

【A HotDocument】のコメント規約とは

コメント規約とは

【A HotDocument】は、下記からダウンロードできる簡単なコメント規約を使っています。
ただし、コメント規約に従っていなくても、ドキュメントの中のコメントを抜き出す部分が空欄になるだけで、問題なくドキュメントは自動生成できます。また、コメント規約のカスタマイズは自由にできます。
つまり、より綺麗にドキュメント化したい場合にのみ、コメント規約に従っていただければ良いのです。

(質問)コメント規約に従っていないソースファイルはドキュメント化できますか?

はい、できます。詳しくはこちらをご覧ください。

ダウンロード

コメント規約、製品マニュアルは下記からダウンロードできます。
chmファイルはzip形式です。chmファイルが開けない場合、こちらをご覧ください。

ファイル名サイズ内容
codingVB_NET.chm57KBVisual Basicコーディング規約
codingVB_VBA.chm51KBVB6.0/Access-VBA/Excel-VBAコーディング規約
codingC.chm56KBVisual C++/C++Builder/ANSI-Cコーディング規約
codingCs.chm60KBVisual C#コーディング規約
codingJava.chm52KBJavaコーディング規約
coding.pdf215KB全言語コーディング規約、PDFファイル
man.pdf178KBマニュアル、PDFファイル

XMLコメント

各言語のコメント記述例は下記の通りです。詳細は、コメント規約をダウンロードしてご確認ください。
Visual Basic/Visual C#版は、XMLコメントと【A HotDocument】形式コメントの両方に対応しております。

Visual Basic

''' <summary>
''' ループの数
''' </summary>
Public Const LOOP_COUNT = 2

''' <summary>
''' 個人の特定情報
''' </summary>
Public Structure PERSON
 Dim Name As String ' 名前
 Dim Age As Integer ' 年齢
End Structure

''' <summary>
''' メッセージ文字列の取得
''' 以下のタグはコメントを抽出できます。
''' </summary>
''' <remarks>
''' メッセージ定義ファイルより指定されたメッセージを取得する
''' </remarks>
''' <param name="FileNum">ファイル番号</param>
''' <param name="Index">インデックス番号</param>
''' <returns>
''' メッセージ文字列
''' </returns>
''' <exception>
''' 例外処理が起きた場合は、エラー出力を行う
''' </exception>
Private Function GetMsg(ByVal FileNum As Integer, ByVal Index As Index) As String
  '' 処理のコメント
End Function

Visual C#

/// <summary>
/// ループの数
/// </summary>
public const int  LOOP_COUNT = 2;

/// <summary>
/// 個人の特定情報
/// </summary>
public struct PERSON
{
 string Name; // 名前
 int    Age;  // 年齢
}

/// <summary>
/// メッセージ文字列の取得
/// 以下のタグはコメントを抽出できます。
/// </summary>
/// <remarks>
/// メッセージ定義ファイルより指定されたメッセージを取得する
/// </remarks>
/// <param name="FileNum">ファイル番号</param>
/// <param name="Index">インデックス番号</param>
/// <returns>
/// メッセージ文字列
/// </returns>
/// <exception>
/// 例外処理が起きた場合は、エラー出力を行う
/// </exception>
private int GetMsg(int FileNum, int Index)
{
  /// 処理のコメント
}

【A HotDocument】形式コメント

Visual Basic/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#/Java

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

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

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##eee", "##" ) -> 6
//    pStrInStr( "abcdeabcde", "AA" ) -> 0
//
int pStrInStr(const char *tarstr,  // 検索される対象の文字列
        const char *srcstr)  // 検索する指定部分文字列
{
  /// 処理のコメント
}