はじめに お客様に提案をしているときの会話です。 お客様：「詳細設計書は作りますか」 私：「昔ながらの詳細設計（ロジックを日本語で書くもの）は作りません。クラス図とか、シーケンス図は複雑であれば作りますが、今回のシステムはそこまで必要なものはないものなので、割愛しようと思っています。」 お客様：「保守をお願いするかどうか未定なので、場合によっては引継ぎのために作ってもらうかもしれません」 私：「・・・・」 といった感じで、私がこの業界に入った30年前は、確かにプログラムを作る前に、詳細設計書と呼ばれるプログラムを日本語で書いていました。 最近、詳細設計と呼ばれるものを作った記憶がなく、無駄なものは作りたくないなぁという思いから、コードから自動生成できないかなと思って、いろいろ試してみました。 Doxygenって いろいろ調べてみると、Doxygen にたどり着きました。 色々な言語に対応し
C#では、通常の”/* */”や “//”によるコメントに加えて、”///”で始まるコメントで、XML形式のドキュメントコメントを記述することが出来ます。 具体的な例としては、下記ソースのsummary,paramや、returns等が相当します。 //*************************************************************************** /// <summary> 指定されたファイルを読み込む /// </summary> /// <param name="fileName">ファイル名</param> /// <returns>ファイルの内容</returns> //*************************************************************************** pri
簡単に自動で「図のあるドキュメント」！通常+αの設定でデキるDoxygen×graphvizドキュメント作成 - lisz-works
コードからドキュメントを自動生成してくれる、力強い味方「Doxygen」！ コイツに「graphviz」というツールを組み合わせると…… ドキュメントに図が勝手に！？ こんな便利なことがあっていいのか！？ ということで、やり方をまとめてみました！ どんなものが作れるの？ Doxygenについて graphvizのインストール インストール確認 テスト用ソース Main.c calc.c calc.h Doxgenファイルの作成 編集する箇所 あとはDoxygenを実行して出力！ 出力ドキュメントの確認 参考 あとがき どんなものが作れるの？ こんなものや こんなものです。 Doxygenについて コチラを参照。 www.lisz-works.com graphvizのインストール このページにアクセスして、手順3へ！ Windows Packages トップページから見る場合は、こちらから
doxygen入門 | tracpath:Works
はじめに doxygenはソフトウェアのドキュメント化を自動で行ってくれるオープンソースソフトウェアです。ソフトウェアは規模が大きくなってきて、開発メンバーが増えてくると、新しく加入するメンバーへの教育方法として、ドキュメントが非常に重要になってきますが、その一方で開発が忙しくてドキュメント化が進まない現状があります。 doxygenはそのような場合にでも、あらかじめ決まった形式でコメントを入れることにより、自動でドキュメント作成を行ってくれる優れたツールです。今回はそのdoxygenの利用方法について学んでいきたいと思います。 レッスン１．doxygenとは まずは、doxygenとは何なのか、何ができるのかを学んでいきましょう。以下がdoxygenの概要です。 対応言語：C/C++、Java、Python、PHPなど 対応OS：Windows、Mac、Linux doxygen公式サイ
Clear, Functional C++ Documentation with Sphinx + Breathe + Doxygen + CMake - C++ Team Blog
Clear, Functional C++ Documentation with Sphinx + Breathe + Doxygen + CMake Writing good documentation is hard. Tools can’t solve this problem in themselves, but they can ease the pain. This post will show you how to use Sphinx to generate attractive, functional documentation for C++ libraries, supplied with information from Doxygen. We’ll also integrate this process into a CMake build system so t
この記事ははてなをメインにQrunch(閉鎖済み)、Crieitにクロス投稿しています 環境 VisualStudio2017 VisualStudio2019 VSCode Doxygenで生成したドキュメントのどこで表示されるかわからない 変数等の@briefは詳解の前の簡単な説明と詳解の後のところに表示。 @detailsは詳解のところに表示される。 コメントの書く場所をどうすべきか VisualStudioではcppに書いたときInteliSenseが機能しなかったので ヘッダーに書くのが良さそうです。 ただテンプレート関数をクラス内で多用するとコメントと合わせかなり行数が増えるので注意が必要です。 どうにかしたい・・・ 前置簡易コメント /// コメント /// @detailsと同じ扱いに int i; /// コメント このコメントはvisualstudioで使うとxmlコメ
この記事の目標 クラス図を自動生成できるツールDoxygenをご紹介します。過去に紹介したUMLDocletとの違いは、Doxygenはコールグラフを追加で出力することができることです。
メインページ コマンド等 コメントブロック ・C / C++ / C# / Objective-C / PHP / Java ・Python ・VHDL ・Fortran ・Tcl 定義別の記述例 Doxygen コマンドDoxygen コマンド一覧 A @a【強調 (イタリック体)】 @addindex【LaTeX：インデックス】 @addtogroup【グループ定義追加 (優先)】 @anchor【アンカー】 @arg【リスト】 @attention【注意】 @author【開発者・著者】 @authors【開発者・著者】 B @b【太字】 @brief【概要】 @bug【バグ (一覧)】 C @c【等幅フォント】 @callergraph【被呼び出し関係図 (生成あり)】 @callgraph【呼び出し関係図 (生成あり)】 @category【クラスカテゴリー (Objective
既存のC++/CLIプロジェクトに対して、Doxygenをかけたときの設定値についてです！ 設定値 externによる重複除外用 各種設定値について 参考 あとがき 設定値 全て載せると大きくなってしまうので、変更した箇所の抜粋です。 項目 編集前 編集後 備考 PROJECT_NAME My Project 任意プロジェクト名 タイトルに反映される OUTPUT_LANGUAGE English Japanese 表示言語お好みで FULL_PATH_NAMES YES No 相対パスに変更 JAVADOC_AUTOBRIEF NO YES /* ～ /を対象にする TOC_INCLUDE_HEADINGS 5 0 忘れた CPP_CLI_SUPPORT NO YES C++/CLI用設定 EXTRACT_ALL NO YES 出力設定(この手の全てONにした) EXTRACT_PRIV
DoxygenでPythonコードをドキュメント化するとき、嵌ったのでmemoを残しておきます。 pythonでdocstring形式のコメントは、関数にカーソル置くとVScodeの編集支援機能でコメントが表示されます。 ■docstring形式コメント例 def leftCosets(self, H: FiniteGroup) -> Set[Set[GroupElement]]: """ @brief Calculates left cosets of H in self. @details foo :param H: subGroup of self :return: @note bar """ cosets = {frozenset(copy.deepcopy(H.elements)),} remain = self.elements - H.elements while len(r
. └── Qiita ├── CMakeLists.txt ├── Doxygen │ ├── Doxyfile.in │ ├── doxygen-script.cmake │ └── doxygen.cmake └── main.cpp cmake_minimum_required(VERSION 3.5) # add_doxygen(という自作関数)を使えるようにする include(Doxygen/doxygen.cmake) set(SOURCE_FILES ${CMAKE_CURRENT_SOURCE_DIR}/main.cpp ) add_executable(Hello ${SOURCE_FILES}) # Helloを対象にしたDoxygen出力をできるようにする add_doxygen(Hello) find_package(Doxygen) if (DOX
DoxygenでPythonコードを文書化
Doxygen は、C++、C、Java、Objective-C、Python、IDL (Corba、Microsoft 風) 向けのドキュメンテーションシステムです。 PHP、C#、Dにもある程度対応しています。 ここの「Python での特殊ドキュメント・ブロック」の項に、このスタイルの説明がありました。サポートされている形式のようですが、残念ながら、「 このケースでは、doxygen の特殊コマンドはどれもサポートされないことに 注意してください。」とのこと。つまり＠ｘｘの部分はただのコメントと判断されるようです。 2020/8/29追記 どうやらこのdocstring倣いの形式もサポートされているようです。ごめんなさい。ただしコメントの開始は「”””!」で始める必要がありそうです。詳細はこちら。日本語のドキュメントの更新が追い付いていないようですね。 これも別に間違った記述というわ
【Doxygen】Pythonのコメント記述例
Doxygenの概要とメリット Doxygen(http://www.doxygen.jp/) とは、専用の記法でコメントを書くことで、自動でドキュメントを作成することができ、GNU General Public Licenseで配布されています。 自作ライブラリを公開している場合は、とても便利です。Doxygenのインストール方法など、詳細は以下ページで解説しています。
【Doxygen】ドキュメント自動生成 プログラムと設計書の乖離を防ぎたい | テクてくブログ 〜技術の道も一歩から〜
[greeting] いくつかの現場を経験してきてどの現場でも悩んでいるシーンを見かけるものがあります。それが設計書とプログラムが違うものになっていること。 「そんな機能設計書に載ってないやん！」なんて何度思ったことでしょうね。 ただ実際現場で仕事していると多いですよね？このシーン^^: 新規参入者には決して優しくない設計書たち。「システム開発は設計してから実装するんだよ」とは分かっていながらも「期限今日までね」とかいう上からの圧力がきて、そうはいかない事情が積み重なった集大成ですね(‘ω’) 今回はとある現場でドキュメンテーションツールDoxygenによって、極力ドキュメント管理の手間をかけないようにしている方々に出会って「Doxygenなかなかいいな」と思ったのでそのご紹介です。 Doxygenとは ソースファイルのコメントから文書を自動生成するドキュメンテーションツールです。 執筆時
Doxygen vs. Sphinx+Breathe
ソースコードに埋め込まれたコメントから文書を生成するツールとして，DoxygenとSphinx+Breatheについて検討し，Doxygen単独での利用が妥当と結論づけた。そのことについてメモしておく。 一連の考察は以下でまとめたツイートがベースとなっている。 Doxygen vs. Sphinx+Breathe – Togetterまとめ Introductionソフトウェアを開発していると，そのソフトのクラスの構成や使い方，概念などが複雑になってくることがある。また，会社など複数人で開発を行っていると，新しく参加する人のためであったり，数年後に忘れた時のために，APIの説明文書（API文書）があるととても役に立つ。 しかし，こうしたAPI文書を作成する労力は無視できない。また以下の点も文書整備の妨げとなるだろう。 ソフトウェアの更新。 文書整備の優先度の低さ。 こうした問題があるため，
【msys2】Doxygenをインストールして使う
使い方 ドキュメント作成したいソースのあるフォルダに移動し、下記コマンドで設定ファイル（Doxyfile）が作成される。 $ doxygen -g 必要に応じて、作成されたDoxyfileを編集して調整する。 実行 下記のようにコマンド実行すると カレントディレクトリにあるDoxyfileを読込み、ドキュメント生成する。 $ doxygen 結果は、「html/」フォルダに出力されてるので、その中の index.html をブラウザで開く。 記述例 コメント記述したサンプルソースを「GitHub」に登録しているので、参考にください。 任意フォルダで下記コマンドで取得。 $ git clone https://github.com/jr4qpv/gcc_sample 取得したgcc_sampleフォルダに移動して、上で説明の doxygen コマンドを実行してドキュメント生成。 ドキュメント
はじめに お客様に提案をしているときの会話です。 お客様：「詳細設計書は作りますか」 私：「昔ながらの詳細設計（ロジックを日本語で書くもの）は作りません。クラス図とか、シーケンス図は複雑であれば作りますが、今回のシステムはそこまで必要なものはないものなので、割愛しようと思っています。」 お客様：「保守をお願いするかどうか未定なので、場合によっては引継ぎのために作ってもらうかもしれません」 私：「・・・・」 といった感じで、私がこの業界に入った30年前は、確かにプログラムを作る前に、詳細設計書と呼ばれるプログラムを日本語で書いていました。 最近、詳細設計と呼ばれるものを作った記憶がなく、無駄なものは作りたくないなぁという思いから、コードから自動生成できないかなと思って、いろいろ試してみました。 Doxygenって いろいろ調べてみると、Doxygen にたどり着きました。 色々な言語に対応し
PythonをDoxygen使ってドキュメント化するよ！ その2 コメントの書き方 - SuiTechLog
前回の記事で、インストールと設定、作成の流れが終わりました。 次に、Doxygen形式のコメントについて解説していきます。 おおまかな流れ Doxygenはコメントに書き込まれた特殊コマンド（@から始まる特殊な文字）を読み取って、独自のルールでドキュメント化していきます。 ルール的にはコマンドの後ろに半角スペースをいれて文章を書き込むのがメインとなります。 # @コマンド 表示させる文章 という形で書いていきます。 注意点として、#と@がくっついていると正しく動作しなかったので、私は、#と@の間はTabキーでインデントさせて空けています。（できあがるドキュメントに差はありません）また、コメントに空白行があると1つのカタマリと認識してくれないので、コメントはまとめて書いてください。たとえば、 以下のように@briefと@authorの間に空白改行があると@briefまでしか認識しなくなりまし
Doxygen入門の入門
概要 Doxygenについてまとめます 入門の入門ということで概要からインストール、簡単に試してみるところまで どういうものかイメージができるまで使おうと思います ちなみに今回の記事で作成したサンプルのソースコードはこちらから確認できます ※ 2018/9/29 ↓続編としてこちらの記事を作成しました、実際にGitHub PagesにDoxygenドキュメントを乗せたのでサンプルを見れるようにしました サンプルを見ながらDoxygenの理解を深める Doxygenについて Doxygenとはドキュメンテーションジェネレータです Doxygenの書き方でソースコードにコメントを書いていくと コメントからドキュメントをHTMLとして自動生成してくれます イメージとしては作成されたドキュメントはこのように確認できる Doxygenの良いところはC++、C言語、Java、PHP、Pythonなど様
Doxygen のインストール（Windows 上）
本サイトは金子邦彦研究室のWebページである． 資料等の公開では，原則，「クリエイティブコモンズ BY NC SA」として公開するようにしている． PDFファイル，パワーポイントファイルなどには， 「クリエイティブコモンズ BY NC SA」を明記するとともに，ロゴを記載するようにしている（作業が間に合っていない分もあるのでご容赦ください）． 公開している資料をご利用になる場合の，再配布の条件，剽窃の防止などについて，別ページ »で説明 再配布や資料改変の際には，そのページをご確認ください． サイトマップは，サイトマップのページをご覧下さい． 本サイト内の検索は，サイト内検索のページをご利用下さい． 問い合わせ先： 金子邦彦（かねこ くにひこ）
Doxygen記述ルール [新石器Wiki]
設定ファイル「Doxyfile」は、doxygen -g コマンド実行でデフォルト値ファイルが生成できる。特に下記項目について留意して設定する。
【C/C++】ドキュメント作成(doxygen)まとめ
１．doxygenとは Doxygen は、C++、C、Java、Objective-C、Python、IDL (Corba、Microsoft 風) 向けのドキュメンテーションシステムです。 PHP、C#、Dにもある程度対応しています。 http://www.doxygen.jp/ と、公式サイトで説明されている通り、ドキュメント生成を行うためのシステムです。 ※ライセンスはGPLで、無料で使うことができます。 ※OSはLinux, Windows, Macで使うことができます。 下図はドキュメント生成のざっくりとした流れです。 まずは、doxygenスタイルのコメントの記述方法からまとめていきたいと思います。 ２．doxygenスタイルのコメント記述方法(とサンプルコード) 2-1 基本 doxygenはすべてのコメントをドキュメント化するのではなく、特定の形式で記述されたコメントのみ
Doxygen：設定 - リファレンス メモ
トップ 言語 等 CSS HTML JavaScript Python ライブラリ・プラットフォーム jQuery micro:bit Xamarin ドキュメンテーション Doxygen ドキュメント コメント JSDoc Markdown SHFB (Sandcastle Help File Builder) XML ドキュメント コメント その他 各種資料 子サイト・SNS 簡易リファレンス・Tips Facebook X サポート寄付 メインメインページ コマンド等 コメントブロック ・C / C++ / C# / Objective-C / PHP / Java ・Python ・VHDL ・Fortran ・Tcl 定義別の記述例 Doxygen コマンドDoxygen コマンド一覧 A @a【強調 (イタリック体)】 @addindex【LaTeX：インデックス】 @addt
目的 本記事では、gitlab-ciを用いて、gitlabにPushされたタイミングでDoxygenによるAPIドキュメントを出力する手順を紹介する。 なお、Doxyfileを生成する過程とDoxyfile、Doxygenについての説明は割愛する。 手順 では、サンプルコードを使って、Doxygenを動かしドキュメントを生成していく。 今回のサンプルプロジェクトは以下のようなディレクトリ配置となっている。 Doxyfileはあらかじめ用意しておく。 . ├── .gitlab-ci.yml #CIのジョブスクリプト └── sample ├── Doxyfile #用意したDoxyfile └── sample.py #ドキュメント生成対象のサンプルソースコード
Help us understand the problem. What are the problem?
Installing Doxygen For Mac MacDoxygen Windows DownloadJun 23, 2017 - Install the App. Press Command+Space and type Terminal and press enter/return key. Brew install doxygen.As a result, it runs on most other Unix flavors as well. Furthermore, executables for Windows 9x/NT and Mac OS X are available. This manual is divided into three parts, each of which is divided into several sections. The first
はじめに CMakeの設定ファイルCMakeLists.txtにdoxygen関連の記述をする方法について述べます．まとめると以下の２点です． make時にコンパイルと一緒にdoxygenを実行できる CMakeLists.txtに書かれたバージョン番号をdoxygenの設定ファイル(Doxyfile など．以下ではdoxygen.conf)に書くことができる．いちいち設定ファイルにあるバージョン番号をいじる必要がない． 必要なもの Doxygen用のコメントがついた自作のライブラリ(以下の説明では，自作のライブラリ https://github.com/tmichi/mibase を使用しています) Doxygen (http://www.doxygen.jp) Windows, Macの両方でできたことを確認しています． 参考資料 https://github.com/qknight/
Q&A：Doxygenで自動的にクラス図・コラボレーション図（コミュニケーション図）・呼び出し関係図等を出力するには？ - 簡易リファレンス・Tips
Q&A：Doxygenで自動的にクラス図・コラボレーション図（コミュニケーション図）・呼び出し関係図等を出力するには？ Q：Doxygenで自動的にクラス図・コラボレーション図（コミュニケーション図）・呼び出し図等を出力するには？ A：Graphviz を使用してソースコードから自動生成する。 構造を記述して出力される図については、下記を参照 『Q&A：Doxygenで構造を記述して各種UML図・メッセージシーケンスチャート・フローチャート等を出力するには？』 詳細 Graphviz を使用すれば、ソースコードから各種図を自動生成することができる。 （以下Doxygenコマンド・設定項目は親サイトにリンク） Graphviz の設定 Graphviz をインストールし下記を設定する。 DOT_PATH【dotツールのインストールパス】：インストールパス HAVE_DOT【dotツールの使用
UNIX系の開発もしくは開発環境に慣れ親しんでいる方たちでdoxygenを知らない方は多分いないと思います。 しかし、UNIX環境が無縁の組込みの現場で既にdoxygenを活用していた、などという現場に出会ったことがありません。 doxygenはC/C++/JAVAなどのソースプログラムからそのソフトウェアの構造や関連を「みえるようにする」ためのツールの一つです。 特に、組込みの特徴の一つである、「コピーして派生物を作る」というスタイルにならざるを得ない開発スタイルの場合、必要不可欠のツールといえます。 にも関わらず、組込みLinuxでの組込み以外の組込み開発の現場では使われていません。 doxygenは当初はUNIX環境でしか動作しませんでしたが、現在はWindows環境での動作も問題なくできるツールで他人の作ったプログラムを解析するのにはなくてはならないものです。 また、納品物としての
皆さま、こんにちは。 今回も引き続き、Doxygen 関連の記事を書いていきます。 過去の記事は以下の通りです。 その 1：Doxygen を使った C ソース静的解析 (その 2：インストール編) その 2：Doxygen を使った C ソース静的解析 (その 2：実行編) 前回は dot は表示されないわ、情報として大したものが出ないわで大変失礼致しました。 前回からコツコツと設定を変更し、ここまでのものができあがりました。 dot によるビジュアライズされたコールグラフも無事表示され、全体的な見た目もかなり見やすくなっていると思います。 今回、変更した個所は以下の通りです。 PROJECT_NAME “My Project” → “ASP” PROJECT_NUMBER 3-3.1.0 (新規) OUTPUT_DIRECTORY ※出力したいディレクトリパスを指定 CREATE_SU
doxygenを使ったクラス図が表示されません。 - GraphvizをインストールしてDoxygenを使ってクラス図を生... - Yahoo!知恵袋
doxygenを使ったクラス図が表示されません。 GraphvizをインストールしてDoxygenを使ってクラス図を生成したいのですが上手くいきません。 htmlは生成されてクラスの相関図やリンクは張られるのですが、クラス図の画像だけが×マークになって表示されません。 何が悪いのか分かりませんでしょうか？ ソースの言語はC++で 開発環境はVisualStatio2008です。 (ちなみにOSは７です）
はじめに お客様に提案をしているときの会話です。 お客様：「詳細設計書は作りますか」 私：「昔ながらの詳細設計（ロジックを日本語で書くもの）は作りません。クラス図とか、シーケンス図は複雑であれば作りますが、今回のシステムはそこまで必要なものはないものなので、割愛しようと思っています。」 お客様：「保守をお願いするかどうか未定なので、場合によっては引継ぎのために作ってもらうかもしれません」 私：「・・・・」 といった感じで、私がこの業界に入った30年前は、確かにプログラムを作る前に、詳細設計書と呼ばれるプログラムを日本語で書いていました。 最近、詳細設計と呼ばれるものを作った記憶がなく、無駄なものは作りたくないなぁという思いから、コードから自動生成できないかなと思って、いろいろ試してみました。 Doxygenって いろいろ調べてみると、Doxygen にたどり着きました。 色々な言語に対応し
(2) 生成されたDoxyfileをプロジェクトに合わせてカスタマイズしていきます。 各項目の詳細な説明はリファレンスをご参照ください。 以下は、私のおすすめ設定です。 # プロジェクト名。Doxygenドキュメントのタイトルなどに使われます。 -PROJECT_NAME = "My Project" +PROJECT_NAME = "任意のプロジェクト名" # 言語を選択します。（が、あんまり影響はないかも。） -OUTPUT_LANGUAGE = English +OUTPUT_LANGUAGE = Japanese # FULL_PATH_NAMES がYESの場合、ファイル名がフルパスで出力され、けっこうわずらわしいです。 -FULL_PATH_NAMES = YES +FULL_PATH_NAMES = NO # とりあえず全部出す -EXTRACT_ALL = NO +EXTR
PS > doxygen.exe -V 1.9.2 (caa4e3de211fbbef2c3adf58a6bd4c86d0eb7cb8) with clang support 5.0.0. 現象 test.h はドキュメント生成するつもりのないファイル。 ただし、以下のようにコメント文に Markdown のコードブロックの開始に該当する記述がある。
メインページ コマンド等 コメントブロック ・C / C++ / C# / Objective-C / PHP / Java ・Python ・VHDL ・Fortran ・Tcl 定義別の記述例 Doxygen コマンドDoxygen コマンド一覧 A @a【強調 (イタリック体)】 @addindex【LaTeX：インデックス】 @addtogroup【グループ定義追加 (優先)】 @anchor【アンカー】 @arg【リスト】 @attention【注意】 @author【開発者・著者】 @authors【開発者・著者】 B @b【太字】 @brief【概要】 @bug【バグ (一覧)】 C @c【等幅フォント】 @callergraph【被呼び出し関係図 (生成あり)】 @callgraph【呼び出し関係図 (生成あり)】 @category【クラスカテゴリー (Objective
コードドキュメントの作成をGitHub ActionsとDoxygenで自動化する - Safie Engineers' Blog!
はじめに Doxygen実行用コンテナの作成 AWS S3を使った静的ウェブサイトのホスティング GitHub Actions むすび はじめに こんにちは。AI Vision グループでリードエンジニアを務めている橋本です。この記事では、コードドキュメントの生成を GitHub Actions と Doxygen で自動化することで、手間をかけずにドキュメントを作成する仕組みを紹介したいと思います。以下のスクリーンショットは作成するドキュメントのイメージです。今回はC++で実装されたアプリケーションを対象に実施していますが、その他の言語であってもこの手法が参考になると思います。 みなさんは、ドキュメントが整備されておらず、コードの理解や、チームメンバーとのコミュニケーションに難しさを感じたことはありませんか？例えば、新たにプロジェクトに配属され、適切なドキュメントがないために既存の実装を
背景仕事でプログラミングする際に、関数に説明を追加する場合が多いため、Doxygen対応のコメント方法について記載する。 記事の目的Doxygen対応のコメント記載方法について記す ここでは、Doxygen対応のコメント記載方法について記す。 ファイルへのコメントファイルの先頭に、ファイル内のプログラムの説明を記載する。 /** * @file ファイル名.h * @brief 簡単な説明 * @author 書いた人 * @date 作成日付 */ 関数へのコメント関数毎に、関数の説明を記載する。 /** * @fn func1(int, int) * ここに関数の説明を書く * @brief 要約説明 * @param arg1 引数の説明 * @param arg2 引数の説明 * @return 戻り値の説明 * @sa 参照すべき関数を書けばリンクが貼れる * @detail 詳
はじめに お客様に提案をしているときの会話です。 お客様：「詳細設計書は作りますか」 私：「昔ながらの詳細設計（ロジックを日本語で書くもの）は作りません。クラス図とか、シーケンス図は複雑であれば作りますが、今回のシステムはそこまで必要なものはないものなので、割愛しようと思っています。」 お客様：「保守をお願いするかどうか未定なので、場合によっては引継ぎのために作ってもらうかもしれません」 私：「・・・・」 といった感じで、私がこの業界に入った30年前は、確かにプログラムを作る前に、詳細設計書と呼ばれるプログラムを日本語で書いていました。 最近、詳細設計と呼ばれるものを作った記憶がなく、無駄なものは作りたくないなぁという思いから、コードから自動生成できないかなと思って、いろいろ試してみました。 Doxygenって いろいろ調べてみると、Doxygen にたどり着きました。 色々な言語に対応し
【Windows】Doxygenをインストールして使う
安定版をダウンロード。 インストーラを実行。 [Everyone] を選択して、あとはデフォルトで進める。 Graphvizをインストールすると、関数のコールグラフやクラスのUML表現が可能になるので、インストールしておく。 使い方 ドキュメント作成したいソースのあるフォルダに移動し、CMDシェルから下記コマンドで設定ファイル（Doxyfile）が作成される。 > doxygen -g 必要に応じて、作成されたDoxyfileを編集して調整する。 実行 CMDシェルから下記のようにコマンド実行すると カレントディレクトリにあるDoxyfileを読込み、ドキュメント生成する。 $ doxygen 結果は、「html/」フォルダに出力されてるので、その中の index.html をブラウザで開く。 記述例 コメント記述したサンプルソースを「GitHub」に登録しているので、参考にください。 任
概要 この記事ではDoxygenPreviewerの説明と、下記のような作成で得た知識のまとめの導入をします。 doxygenのソースコードのコンパイルとそれに関すること Visual Studio Codeの拡張機能の作成方法とそれに関すること DoxygenPreviewer なにそれ 筆者が作成した、現在編集しているCソースコードのdoxygenをすぐに見れる、Visual Studio Codeの拡張機能です。C言語用です。C++もある程度はOKです。 https://github.com/hakua-doublemoon/DoxygenPreviewer に公開しています。 近いうちに（何事もなければ）マーケットにも出します。 Marketplaceで公開されました。使ってみてください。 なぜ作った というのが今の開発現場のコードレビューでよくあるからです。 解決策としてはDox
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
詳細設計書なんて、書きたくない・・・・Doxygenを使って自動生成してみる - Qiita
doxygenを使用してC#のドキュメントを自動生成する(その1)
c,c++のコメントメモ（doxygenを使用) - じゅぴの記録帳
Javaのクラス図やコールグラフを自動生成する ～Doxygen～
Doxygen【汎用ドキュメントジェネレータ】：メインページ - リファレンス メモ
Doxygen 現状適用している設定と意味合い - lisz-works
DoxygenでPythonコードをドキュメント化 - Qiita
CMakeのビルドターゲットに関連付けされたDoxygenを実行する - Qiita
詳細設計書なんて、書きたくない・・・・Doxygenを使って自動生成してみる - Qiita
gitlab-ciでDoxygenを動かす - Qiita
DoxygenによるMarkdown形式からのドキュメント作成 - Qiita
Installing Doxygen For Mac
CMakeをつかったmake時にdoxygenが実行されるような方法 - Qiita
組込み屋さんではdoxygenは普及していない: 組込み徒然草
Doxygen を使った C ソース静的解析 (その 3：設定編) | からくりブログ
詳細設計書なんて、書きたくない・・・・Doxygenを使って自動生成してみる - Qiita
今さらながらDoxygenの便利さを語ってみる - Qiita
Doxygenで生成されるドキュメントにC言語のマクロ定義が出てこないことがあるのを調査 - Qiita
Doxygen【汎用ドキュメントジェネレータ】：メインページ - リファレンス メモ
Doxygen対応のコメント記載方法(C, C++)
詳細設計書なんて、書きたくない・・・・Doxygenを使って自動生成してみる - Qiita
VSCodeでDoxygenのプレビューをしたい！ - Qiita