Javadocとは

Javaでは、「Javadoc」と呼ばれるコメントを記述できる。これは、プログラムについて説明するドキュメントをソースコードに埋め込むためのものである。
　
Javadocは、クラスの概要やメソッドの概要を記述しておくと、その情報からHTML形式のドキュメントファイルを生成してくれる。
Java Platform SEのAPIリファレンスは実際に、この機能を使って生成されている。
　

Javadocの書き方

Javadoc内では、コメントを記入する際にクラスやメソッドの役割を示すためにタグを使用する。使用できるタグには以下の種類があります。

タグ名	説明
@author	クラスの作成者情報を記載
@param	メソッドの引数の説明
@return	メソッドの返り値の説明
@throw	発生する例外クラスを指定
@see	他のAPIを参照する場合に記載
@deprecated	推奨されないAPIであることを示す
@serial	直列化されたフィールドの説明
@sesrialData	直列化された状態でのデータ型と順序を記載
@since	導入されたバージョンを記載
@version	バージョンを記載

XCode

XcodeでメソッドのJavadocコメント追加を瞬時に行えるようにするプラグイン[VVDocumenter-Xcode]を試す

使いかた

method の前で /// ← と入力するだけ

※ 注意点としては、プラグインの最新版はXcode 4には対応していない
※ Xcodeのショートカットに依存しているので[Paste]と[Delete to Beginning of the Line]がデフォルトと異なる場合にはうまく動作しない

インストール

次のコマンドを実行してください。

git clone https://github.com/onevcat/VVDocumenter-Xcode.git
cd VVDocumenter-Xcode
xcodebuild -project VVDocumenter-Xcode.xcodeproj

その後、Xcodeを再起動をお願いいたします。

~/Library/Application\ Support/Developer/Shared/Xcode/Plug-ins にプラグインフォルダが生成されているので、アンインストールしたいときはこれを削除してください。

関連記事

【About】(http://qiita.com/sunstripe) - サンストライプ

制作チーム：サンストライプ

http://sunstripe.main.jp/

(月１WEBコンテンツをリリースして便利な世の中を作っていくぞ！！ボランティアプログラマー/デザイナー/イラストレーター/その他クリエイター声優募集中！!)

地域情報 THEメディア

THE メディア地域活性化をテーマに様々なリリース情報も含め、記事をお届けしてます！！
https://the.themedia.jp/

ゼロからはじめる演劇ワークショップ

多様化の時代に向けて他者理解を鍛える

プログラミングワークショップ・ウェブ塾の開講！！！

様々なテーマでプログラミングに囚われずに取り組んでいきます。
詳しくはこちら　↓　↓　↓　↓　↓　↓　↓　↓
プログラミングサロン月１だけのプログラミング学習塾

協力応援 / 支援者の集い

チーム：サンストライプ

プログラミングラボ

一緒にポートフォリオを作りませんか？現場の体験やそれぞれの立場から年齢関係なく作品を作りたい方々と一緒にチームを作って、作品を作っています。現場に行きたい人には、職場紹介や職場の体験や悩み相談なども受けております。
様々な職種からプログラミングの知識を得たい、デザインの知識を得たい、データーベースの知識を得たいという人が集まっております。
週１のミーティングにそれぞれの近況と作業報告して、たまにリモート飲み会などをしております！！

興味がある方は、DMに話しかけてみてください。

トラストヒューマン

http://trusthuman.co.jp/
私たちは何よりも信頼､人と考えてます｡

｢コンサルティング｣と｢クリエイティブ｣の両角度から｢人材戦略パートナー｣としてトータル的にサポートします！！

キャリア教育事業
広域学習支援プラットフォーム『のびのび日和』
https://slc-lab.amebaownd.com/