- PR -

コメント規約

1|2 次のページへ»
投稿者投稿内容
ひろし
ぬし
会議室デビュー日: 2002/09/16
投稿数: 390
お住まい・勤務地: 兵庫県
投稿日時: 2007-11-07 23:51
質問1
Javaの世界で、一般化された標準のコメント規約はありますか？

質問2
クラスやメソッドのヘッダーコメントをIDEに表示させることはできますか？
VisualStudio2005でC#の開発を行っている場合、"///"とタイプすると、自動的にヘッダーコメントのテンプレートが作成され、クラスやメソッドを呼び出す時に、パラメータリストと一緒にヘッダーコメントが表示されます。同じようなことをNetBeans実現したいのですが可能でしょうか？
じゃんぬねっと
ぬし
会議室デビュー日: 2004/12/22
投稿数: 7811
お住まい・勤務地: 愛知県名古屋市
投稿日時: 2007-11-08 00:55
引用:

ひろしさんの書き込み (2007-11-07 23:51) より:

質問1
Javaの世界で、一般化された標準のコメント規約はありますか？

質問2
クラスやメソッドのヘッダーコメントをIDEに表示させることはできますか？
VisualStudio2005でC#の開発を行っている場合、"///"とタイプすると、自動的にヘッダーコメントのテンプレートが作成され、

C# のそれはむしろ Java からパクったものですよw (MVP for C# の立場で言ってよいことかわかりませんが)

'/** ･･･ */' という Java 独自ルールは有名ですよね。 Microsoft の J# でも採用されています。 メソッドの説明、パラメータ、戻り値などを @param, @return で書きます。 これと似たものが C# や VB.NET にある XML コメントですね。

_________________
C# と VB.NET の入門サイト
じゃんぬねっと日誌
かつのり
ぬし
会議室デビュー日: 2004/03/18
投稿数: 2015
お住まい・勤務地: 札幌
投稿日時: 2007-11-08 02:13
標準といえるコメント規約はないと思いますが、
大抵のJava技術者が読みなれている、
SunのAPIのようなコメントを書くことをお勧めします。

・@seeや@param等のタグは最低限つけること
・ですます調で書く
・予約語の装飾を行う
・メソッド名やクラス名は{@link}タグを使う
・URL等はリンクで表現する
等‥APIの翻訳のガイドラインも参考になるでしょう。


NetBeansならJavadocのポップアップ表示ができるはずですが、
試したけどダメだったという話ですか？
るぱん
ぬし
会議室デビュー日: 2003/08/01
投稿数: 1370
投稿日時: 2007-11-08 09:54
るぱんです。

こんなのどうだろう？
確か載っていたと思う。
立ち読みでもしてみて下さい。

JAVAのルールブック
じゃんぬねっと
ぬし
会議室デビュー日: 2004/12/22
投稿数: 7811
お住まい・勤務地: 愛知県名古屋市
投稿日時: 2007-11-08 10:00
つ 三 ◇ 三 ◆

# ふ、古い...

_________________
C# と VB.NET の入門サイト
じゃんぬねっと日誌
かつのり
ぬし
会議室デビュー日: 2004/03/18
投稿数: 2015
お住まい・勤務地: 札幌
投稿日時: 2007-11-08 10:40
JDKをインストールすると、%JAVA_HOME%にsrc.zipが入るので、
それを展開するとAPIでどんなコメントが書かれているかを見ることが出来ます。

SunのAPIはそれなりに丁寧ですが、アプリのコメントとしては少々過剰かなとも思います。
APIのコメントを見ながら、プロジェクトにあわせたポリシーを適用してみてはいかがでしょうか。
nagise
ぬし
会議室デビュー日: 2006/05/19
投稿数: 1141
投稿日時: 2007-11-08 14:24
javadocのドキュメントを読みましょう。
JDKに同梱されているjavadocというツールでドキュメント生成を行います。
その際に利用される、/** - */形式のコメントで使用可能なタグについての
詳細な説明もされていますし、生成されるドキュメントの構造も記載されています。

http://java.sun.com/j2se/1.5.0/ja/docs/ja/tooldocs/windows/javadoc.html
ひろし
ぬし
会議室デビュー日: 2002/09/16
投稿数: 390
お住まい・勤務地: 兵庫県
投稿日時: 2007-11-08 23:56
ご回答ありがとうございます。

NetBeansに下記のようにタイプしました。
しかし、Addメソッドの呼び出し側に日本語のコメントが表示されませんでした。
どこに問題があるのでしょうか？
コメントをタイプするだけではだめなのでしょうか。
よろしくお願いします。

/**
* 加算
* @param a 加算の引数1を表します。
* @param b 加算の引数2を表します。
* @return 加算の結果を返します。
* @version 1.6
*/
public static int Add(int a,int b) {
return a+b;
}
1|2 次のページへ»

スキルアップ／キャリアアップ（JOB@IT）