«前の日記(2018年11月06日) 最新 編集

日々をアレコレ


2018年12月04日

Visual Studio Codeでdoxygen

個人が何かを目標を持って業務を取り組んでいるというよくわからない活動をしなきゃならなくったので、できるだけ深呼吸くらいの手軽さで実現できるものをと考えた結果、ソースファイルにコメント入れてDoxygenに食わせてソースの仕様を自動生成することにした。で、その時にやったことをざっくりとメモ。

まず、Dogygenの環境をインストール。今回はWindows向けのsetupファイルをダウンロードしてインストール。インストールしたのは少し前であまり覚えていないのだけど、多分デフォルトでインストール先をパス通すようになっているらしいので、とりあえずこれでどこからでもdoxygenコマンドが呼び出せるようになる。次に、出力ファイルの設定をする。ソースコードからドキュメントをDoxygenで生成する を参考に、doxywizardを使って、ファイルの保存先、ソースファイルのルートディレクトリ、出力先の設定や出力方法などの設定をウィザードで編集して保存する。今回は、ESP-IDFのプロジェクトメインフォルダを対象に、日本語でHTMLファイルを生成するような設定を作って保存した。念の為、実行して内容を確認。ここまででとりあえず、コメントから仕様を自動生成することができるように。

で、今やっているのはESP-IDFのプロジェクトをVisual Studio Code上で開発しているので、その設定もしておく。まず、VSCodeに拡張機能 Doxygen Documentation Generator - Visual Studio Marketplace をインストール。これで、/** と入力して開業すると直後の行のヘッダがテンプレートから作られる。ファイルの先頭だとファイルヘッダコメントになる。これがあるとだいぶと楽になる。次に、プロジェクトの「task.json」ファイルを編集して以下のタスクを追加する。

"label": "make doxygen",
"type": "process",
"windows": {
    "command": "doxygen",
    "args": [
        "(保存した設定ファイルのパス)"
    ]
}

コマンドパレットから「タスクの実行」を選択して、「make doxygen」を実行すると設定ファルに従って仕様が生成されるようになる。これで、VSCodeだけで仕様書まで生成できるように。


«前の日記(2018年11月06日) 最新 編集