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

1.8 キーワードの変更

メソッドの頭書きのキーワードは自由に追加,削除できる。
変更する場合には,【A HotDocument】のメニューの[環境設定(E)]-[コメント(C)]より設定をする。

■メソッド頭書きのコメントの例

//
// 機能 : 文字位置の取得
//
// 返り値 : 文字位置[byte](検索されなかった場合は 0を返す)
//
// 機能説明 : 文字列の中から,指定文字列を検索し位置を返す。
//
// 作成日  : 2007年09月15日
//
// 作成者  : 今井 浩司
//
// 使用例 : pStrInStr( "a#c#d#eeee", "#" ) -> 2
//       pStrInStr( "a#c#d##eeee", "##" ) -> 6
//       pStrInStr( "abcdeabcde", "AA" ) -> 0
//
// 注意事項 : 最大配列数以上の,配列を作らなければいけない。
//

■メソッド頭書きのコメントの例(JavaDoc)

  /**
   * JavaDocの説明でも、これらのタグはコメントを抽出できます。
   * 複数行にまたがった説明も記述できます。
   *
   * @newKey 新規タグはこのように記述します。
   * @returns 返り値はこのように記述します。
   * @attention 注意はこのように記述します。
   */