プログラミングと心理学の忘備録

自分の知識をストックしていくためのブログ

開発に便利なテキストエディタ「atom」でDocコメントを書く方法

スポンサーリンク

atomはGitHubが開発したオープンソースのテキストエディタです。

Web開発者に人気らしいので、試しに使ってみています。

色々な機能がもとから実装されているのですが、パッケージをインストールすることでさらに作業がはかどります!

 

パッケージのインストール

  1. File > Settings (ファイル > 個人設定)を選択
  2. +Installから検索ボックスに必要なパッケージ名を入力して検索
    (今回はDocコメントを書くためのdocblocker)
  3. Installボタンを押下

f:id:chi_tana:20161108002316p:plain

 

Docコメントを書く

※Docコメントとは、メソッドの上に書いてある説明用のコメントのこと。

ファンクションや変数の宣言の真上に/**(または###)を書き、Enter(またはTab)を押すと自動で定型文を表示してくれます。

 

f:id:chi_tana:20161108013243p:plain

 

※実は一度プラグインを入れても効かなかったので、atomをアンインストールしてから再インストールを行いました。その過程で参考になったものを記載します。

 

プログラムのアンインストールでは設定が残っているようだったので。

prpr.hatenablog.jp

 

また、atomを既定のプログラムに設定する場合、バージョンが更新されるとatomが起動できなくなるらしいので、下記を参考に対応。アイコンがバッチアイコンになるのは残念。

qiita.com