はじめに
!今回はとりあえず使うを目標にしています。
macでやってます！
簡単にドキュメントを作れるといったdoxygenを使ってみました！
最初はgit cloneしてmake…な感じで難しいのかと思いきや、、、
アプリインストールして使う的な感じのものでした。
なのでアプリ(ツール)の紹介です、、、
あと使用できる言語できない言語ありますのでご了承ください
対応言語は以下みるにC++が基本でその他にC, Objective-C, C#, PHP, Java, Pythonなどみたいです。
https://www.doxygen.nl/index.html
Step1 使用ツールのダウンロード
https://www.doxygen.nl/download.html#srcbin
にいって私の場合macだったので、以下をクリックしてダウンロードしました。
windowsの方はexeとか書いてあるものをダウンロードする感じかと、、、
step2 使えるように
インストール終わったら〇〇.zipがインストールしたブラウザの下の方に出てくるかと思うのでクリック
以下出てくるのでラーメンみたいなアイコン『Doxygen』と書いてるものクリック。
以下のようになるので一旦『キャンセル』をクリック
以下のように設定ファイルのセキュリティプライバシーのところに『使用がブロックされました… このまま…』って出てくるので『このまま開く』をクリック
ちなみにこの画面は、歯車的なアイコン
『システム環境セット』-> 『セキュリティとプライバシー』 -> 一般のタブのところです！
上記タップで開くボタンが出るので『開く』をクリック
step3 早速使う
あとは使用するもの選択してRunするのみという感じです。
①
ドキュメントしたいものフォルダ選択。
以下は私が選択したものの中身です。
②
Runタブ選択
③
Run doxygenクリック
④
Show HTML outputクリック
ちなみに以下出力されました。
面白いですね！
おまけ
ソースコードが配下に全てあるものであれば上記操作で終了。
ただ、フォルダ内全ての検索だと以下チェック必要。
ちなみに、フォルダやファイルが多いととんでもなく時間かかるので検索するフォルダは限定した方が良きかと、、、
ちなみに出力されたものです。
あと言語のモード指定場所の紹介。PHPの場合はPHPを指定する方がいいのかな？と感じています。
さいごに
コードじゃなくてドキュメントで見たいな〜〜〜って時に便利だと感じました。
もう少し深く知りたいと思ったら勉強したいと思います！