snuffkinの遊び場

IT関係、スポーツ、数学等に関することを、気が向いたときに書いてます。

変数コメントを生成するHack

定型的なコメントを書くのが面倒な方に贈るHack。

勢いに乗って実装中に、あなたはpublic変数を宣言したとします。

    public String hoge;

↑こんな感じでね。ここで、本当は流れに乗ってどんどん実装したいんだけれど、コメントもつけなくちゃいけないから、コメントをつけたとしましょう。

    /**
     * type:java.lang.String name:hoge 
     */
    public String hoge;

↑みたいにね。このコメント自体には意味ないですが、定型的なコメントをつけなくちゃいけない状況だったと仮定しておきます。

このとき起こる問題は「コメントに気を取られているうちに、意識の流れが妨げられる」ということ。生産性落ちますね、これは。こういう流れを止めたくない人に、変数コメントを生成してくれるHackです。

    /**
     * @when
     *   public in field.modifiers
     */
    public void found(CtField<?> field,
                      DocFactory tool) {
        String type = field.getType().getName();
        String name = field.getSimpleName();
        String text = "/** type:" + type + " name:" + name + " */";
        CtJavadoc javadoc = tool.parseJavadoc(text);
        field.getJavadoc().substitute(javadoc);
    }

@whenのところは状況に応じて、もっと絞る書き方の方が良いですね。また、textの中身は適切な内容に変えるべきですね。また、この書き方だと、既に存在するJavadocも強制的に置換するので、要注意です。

これは、リアルタイムで利用するHackでなく、後でまとめて一度だけ動かすHackとして利用した方が良さそうですね。

このお手軽さは、さすがIrenka。