doxygenを利用して、コメントから自動に資料を作成することをやって見ました。
この度はその次の内容になります。
doxygen利用して、コメントから自動に資料を作成するのは良いですが、
色んなプログラミング言語をサポートすることも良いですが、
コメントの作成方法を勉強する必要がありますね。
それぞれの言語の独自のコメント書き方が慣れていれば、そのまま利用もできるし、
もし、慣れてない場合だったら、doxygenコメントのみを利用しても良いことにしたい！ーと思いました。
かつ、sassdocのコメントや基本的に入れて頂きたいコメントの内容もありました。
それで、vs-docblockrと言うvs codeの拡張機能を利用することにしました。
が、足りない部分がありました。
例えば、基本的に入れて頂きたいコメント内容とか色んな言語でdoxygenのコメントを利用したいとかのところが修正必要がありました。
sassdocのコメントはsassdoc拡張機能もありましたが、不足部分が多かったので、かつ、拡張機能一つで終わらせたいと言う希望からvs-docblockrを修正して、利用することにしました。
正式名は「VS DocBlockr」です。
元のレポジトリはこちらです。
https://github.com/jeremyvii/vs-docblockr
今回プロジェクトのeslintに合わせて、doxygenやsassdocのコメントに合わせて、基本的なコメントは書くように変更した内容はこちらです。でたらめで、よろしくない実装になっているので、正式にプールリクエストやマーケの登録はしないですが、公開だけはやるのは、提供してくれた方への尊重の表現です。
後で、時間が有ったら、概要や説明までも自動に記載してくれるように変更したいと思います。
説明をAI利用して、自動に書いてくれる拡張機能は既にありまして、日本語は支援しないため、日本語翻訳機能も追加が必要とは思います。
インストールしたら、設定からscssのコメント書き方を変更することを忘れないようにしてください。
