14日目 Copyright プラグイン

地味だけど他じゃ見かけないおもしろプラグインのCopyrightプラグインです。なにをやってくれるかというと,プロジェクトの所定のファイルにいわゆるファイルヘッダを追加してくれるだけプラグインです。
ファイルヘッダというのは,例えばこうゆうやつです。オープンソースだとライセンス表記などが記載されているあれです。

//==================================================================================================
// Copyright (c) 2012. Lorem ipsum dolor sit amet, consectetur adipiscing elit.                    =
// Morbi non lorem porttitor neque feugiat blandit. Ut vitae ipsum eget quam lacinia accumsan.     =
// Etiam sed turpis ac ipsum condimentum fringilla. Maecenas magna.                                =
// Proin dapibus sapien vel ante. Aliquam erat volutpat. Pellentesque sagittis ligula eget metus.  =
// Vestibulum commodo. Ut rhoncus gravida arcu.                                                    =
//==================================================================================================


そんな下らないと侮ることなかれ。コメントを付加するファイルは細かく指定ができる(File->Settings->Copyright)し,コメント位置やスタイルもファイルタイプごとに指定ができます(File->Settings->Copyright->Formatting)。面白い設定で,コメント枠の設定や,枠を箱形に括るかどうかすら設定できます。


なかなかやり過ぎで楽しいです。


コメントの適用は,Code->Update Copyrightで行います。結構優秀で,単純にヘッダコメントを追加するだけではなく,すでにヘッダコメントがついている場合は更新してくれます。(IntelliJユーザにオープンソース開発者が多いので)Copyrightというように,本来はライセンス表記のコメント設定が目的なのだと思います。ただ,お仕事で作るギョーミーなプログラムも古典的なヘッダコメントを指定されることが多いので,活用シーンは意外とあります。



コメント部分はVelocityライクな置き換えキーワードがあります。詳しくはヘルプを参照してください。
Copyright Profiles - Help | IntelliJ IDEA


ps.
先ほども言いましたが、「追加するだけ」ではなく、正確にはヘッダコメントの「更新」を行います。つまりヘッダコメントのテンプレを空行にして、Update Copyrightを実行するとあら不思議。元から記述してあったヘッダコメントが一掃されます。なんとなしに悪どいことしか思いつかないけど、そんな使い方もできますよ。:-)