javaDocの出力

参考サイトはJetBrainのサイトです。

現在作成しているテキストRPGのクラスが増えてきたので、そろそろとJavaDocを出力してドキュメントなどにまとめておこうと考えました。

JavaDoc出力手順

参考サイトの手順委従い、進めていくと下のように、エラーが出ました。

文字コード(エンコード)指定が間違っているようです。

警告

no summary or caption for table

このような警告がありました。

/**
 * プレーヤーを表現するクラス。
 * 名前の最大文字数は６文字<br>
 * <table>
 * <tr><td>共通項目</td><td>意味</td></tr>
 * <tr><td>攻撃力</td><td>現在装備している武器力 + 対象の射程攻撃力(ステータス)</td></tr>
 * <tr><td>防御力</td><td>現在装備している防具力 + 防御力(ステータス)</td></tr>
 * <tr><td>武器</td><td>メインとサブがあり、アビリティにより使用方法法が異なる</td></tr>
 * <tr><td>防具</td><td>防具、着脱は、Map画面でのみ可能</td></tr>
 * </table>
 * @author 実装者の名前
 */

テーブルにsummary="XXX"をつか白という意味らしいです。

JavaDocでのエスケープ文字

「\(バックスラッシュ)」を使うようです。

実行結果

警告が多少ありましたが、後々に直す方向で。。。

出力した結果はGitにアップしてあります。

Github Page

Githubのドキュメントを参考に作成しました。
対象になるリポジトリのルートに「docs」フォルダを作成しそこにHTMLを配置する形でないとうまく動かないようです。
自分の作成した方法は以下のようになります。

1. IntelliJでJavaDocを出力する
2. 出力するフォルダ、プロジェクト直下(ルート)に「docs」を作成
3. それをPUSHする。