Atom で Docblock を楽に書く為のパッケージ Docblockr

プログラムを書く際必要になるのがコメントです。中でも Docblock と呼ばれる形式のコメントは読みやすく、Javadoc や PHPDoc 等の他のソフトウェアにより自動的にドキュメントとして出力できる為便利です。

この Docblock は書き方が決まっている為手動で全て書くのは面倒です。エディタに Atom を利用しているのであれば Docblockr というパッケージを利用する事で簡単に Docblock 形式のコメントを記述する事ができるようになります。

https://atom.io/packages/docblockr

Docblockr を有効にした状態であれば、以下のようにメソッド名でブロック形式のコメントを記述する際に、自動的にメソッド名やその引数などを含めた Docblock 形式のコメントを入力してくれます。

Dockblock を生成した後は Tab を押す事で各フィールドを順番に入力する事ができます。

対応している言語は以下の通りです。

• ActionScript
• C, C++, Cuda-C++
• CoffeeScript
• Groovy
• Haxe
• Java
• JavaScript
• ObjC, ObjC++
• PHP
• Rust
• SASS
• TypeScript

また、Docblock 以外にもコメントの装飾などを行う事もできます。

コメントを書くのが捗りますね。