AtomでPHPDocや複数行コメントの入力がdocblockr使ってめちゃめちゃ楽になった

AtomでPHPDocや複数行コメントの入力がdocblockr使ってめちゃめちゃ楽になった

「これ書いたほうがいいやつだよな」と思いながら全然書いてこなかったPHPのDocコメント

そもそも複数行コメントをスペースと*を何度も押してを作っていたくらいなので、「めんどくさいなぁ」と思い続けていたのですが、調べてみたら「docblockr」というパッケージがめっちゃ便利だったのでその紹介です

コメント入力がめっちゃ楽になるAtomパッケージ「docblockr」

よっひー(@yosiakatsuki)です。

他人のコードを参考にしているとよく見る@paramとか@returnの文字。PHPDocと言うらしい。

「多分IDE使えば自動生成してくれるんだろうなぁ」と思いつつ、Atomのステッカーを買ってしまった手前、Atomから離れる気にもなれなかったのですが…

調べてみたら「docblockr」というパッケージがPHPDocだけでなくコメント記入にもめちゃめちゃ便利なようだったので使ってみました。めっちゃ便利!

複数行コメントもサクサク書ける

複数行コメントもらくらく入力

「docblockr」を有効化すると、デフォルトで/**まで記入してentertabを押すとコメントの終わりまで自動で補完してくれます。

しかも、コメント内で改行した際に、先頭に*を自動で入力してくれます!

今まで頑張ってスペースと*を入力していたの何だったの?と言いたくなります

関数の引数を自動で抽出してくれる

関数の引数を抽出して自動でアノテーションを書き出してくれる

パッケージを探した本来の目的はPHPDocを書くためでした。

上のGIFのように、関数が先に作ってある状態でコメントを書き始めると@param@returnを自動で補完してくれます

しかも、tabキーで入力すべき部分にフォーカスされるのも嬉しい限りです!

ちなみに「docblockr」のドキュメントを確認すると、次の言語に対応しているようです(記事執筆時)

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

とりあえず僕が今のところAtomでコード書いている言語では事足りそうです。

これからはコメントもしっかり書きたいと思います(思います