2012-01-03 7 views
0

プロジェクトのソースコードのドキュメントコメントをライブラリとしてビルドします。そのライブラリを使用している新しいプロジェクトでAndroidのドキュメントのようにそれらを使用する方法は?アンドロイドのような私のプロジェクトでドキュメントのコメントを使用する方法は?

+1

はあなたが何かのようにすることを言い換えるでした。..意味がありますか? –

答えて

2

私はあなたが何かを文書化したいところはどこでもあなたはこの

のように行うことができると思う私はあなたの質問から理解して何を1としては、Methodeのの上に蟻酸、または変数または任意のクラスの下におきます。次回にそのメソッドまたは変数またはクラスにマウスを移動すると、ドキュメントのようになります。

/** 
* getDocument() method gives you 
* @parameter String USerID 
* @return String 
*/ 
public String Document(int UserID) throws Exception 
{ 
return documentString; 
} 

ここでギ酸塩部分については、上に挙げたものすべてを書いてください。 @パラメータ、@戻り値など

+0

このコメントは別のコメントとどのような違いがありますか? – NrNazifi

+0

通常のコメントを使用している間は、上記の方法に惑わされたときにコメントを見つける必要がありますが、上記の方法を使用した場合はいつでもコメントを書くことができます。 –

+0

サンプルリンクをご紹介できますか? – NrNazifi

1

あなたのコメントからHTMLドキュメンテーションページを生成するjavadocを探していると思います(あなたのコメントがjavadoc形式に従っている場合)。ここで私はあなたが探しているものを推測Javadoc

+0

はい、私のコメントはjavadoc形式ですが、HTML文書を生成した後で、アンドロイドのドキュメントのように使いたいと思います! – NrNazifi

+0

私が「アンドロイドのようなものを使用する」ことを理解していれば、これらのHTMLをソフトウェアの一部としてパックするだけです。そうでなければ、その文を詳しく教えてください。 – kosa

+0

もちろん、それは真実です。あなたはそれを持っています。 – NrNazifi

関連する問題