2011-01-13 36 views

答えて

6

Javadocの世代は(.htmlファイルを書く)オンデマンド([ツール] - > [Javadocを生成)あなたのために行われ、あなたがそれを設定すると、基本的に自動化されています。 Eclipse用のjautodocのjavadoc スタブの生成は、メソッドバイステップでクラスごとに実行されます。

メソッドシグネチャの上に/** <enter>と入力すると、Javadocスタブが作成されます。私はあなたが(jautodocのように)ファイル、パッケージ、またはプロジェクト全体でこれを行う何かをしたいと思う。以前はこのプラグインがありました:http://plugins.intellij.net/plugin/?id=952しかし、それは10で動作しません。

このjautodocの例は、きちんとしたパーティートリックは、私が今まで見た中で一番無駄なものですIDE:変数名に基づいた説明を作成しますが、変数名が説明的で最初の場所にコメントが必要ない場合にのみ記述します。

/** 
* The number of questions 
*/ 
private int numberOfQuestions; 

あなたはパンチカードを憧れます。

+5

いくつかのビルドシステムでは、checkstyle、jalopyなどを使用しています。これらのシステムでは、不足しているjavadocsを追加する必要があります。ベストプラクティスはあなたのコードを自分自身で表現することですが、必要な企業ポリシーのために膨大なデータを作成しているときは、jautodocのような機能があればうれしいです。 ctrl alt jとコミットするのは良いです。 – branchgabriel