トップ 言語 等 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
(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
後々ドキュメントを自動生成する目的で、C,C++等でコーディングするときはDoxygenやJavaDoc用のコメントを記載することが多いです。 Doxygenは普通に使うとデフォルトではHTMLを出力してくれます。普段はそれでいいのですが、1ファイルでポンと渡せる方が便利な場合がありますよね。 DoxygenのHTML出力は大量のファイル群で出力されちゃうのですが、たまにそれだと困る事があるのです。たとえば 客先へ納品するとき 社外とか、チーム外の誰か他の人に渡す時 印刷したいとき のような場合です。PDFで出力できれば便利なのに、と思うのが人情です。 もちろんDoxygenはPDF出力ができますのでそこは問題ありません。 問題は日本語フォントが美しくなかったり、しおりが文字化けしたり、ハイパーリンクがうまく動作しなかったり、というトラブルが多くてなんだかもやもやしてしまう点にあります。
前提 細かい手順は控える Windows での導入を前提とする Doxygen自体はマルチOS対応なので, 設定項目はLinux等でも共通のはず... 1. コールグラフを描くために必要なもの Graphviz。 公式サイト等から入手し、インストールして、dot.exeのあるディレクトリを控えとく。 2. コールグラフを描くために必要なDoxygenの設定 EXTRACT_ALL = YES # Doxygenコメントの書いてない関数も対象にしたい場合 SOURCE_BROWSER = YES RECURSIVE = YES HAVE_DOT = YES DOT_NUM_THREADS = 4 # 0でもいいがスレッドがあると処理が早い CALL_GRAPH = YES CALLER_GRAPH = YES DOT_PATH = "C:/Program Files/Graphviz2.38
DescriptionNOTE: as of 0.4.1, @param can document phpdoc.de-style, with optional $paramname The datatype should be a valid PHP type (int, string, bool, etc), a class name for the type of object, or simply "mixed". Further, you can list multiple datatypes for a single parameter by delimiting them with the pipe (e.g. "@param int|string $p1"). You may document parameters listed or any optional paramt
Doxygen 経緯以前から一部のリポジトリで phpdoc がメモリ不足で落ちて困っていたDoxygen は何年か前にも試していたが、PHP の解釈がイマイチで採用を見送っていた今回試してやはりイマイチだったが、いくつかの問題を我慢すれば使えそうだったので、メモリ不足で落ちるよりマシと判断して使い始めた現在稼働しているバージョンは 1.5.6 動かせるようになるまで最初は 落ちる返ってこないファイルが後を絶たなかった。どうしたか。 EXCLUDE しまくるまずはこれが基本。設定ファイルの中に EXCLUDE, EXCLUDE_PATTERNS の設定があるのでこれを利用してひたすら問題になるファイルを除外しまくる。話はそれから。 とりあえず EXCLUDE一つずつコメントやコードの構造を直して落ちないか試す以上をくり返すことでほとんどのコードを扱えるようになる。 ※ Warning はと
新トップページへ ｜ Ｔｉｐ ソースコードからドキュメントをDoxygenで生成する LastUpdate : 13/01/02 JavaDoc的なことをC++でもやろう、という話です。 正直、JavaDocで生成したHTMLを見て役に立ったことがあまり有りませんが、コメントを書く際の統一的な書式としては役に立つと思います。 もくじ はじめに Doxygenのインストール コメントの書式 ドキュメントを生成する はじめに 詳細はこちら(http://www.doxygen.jp/)を参照。 日本語サイトがあるので、非常に便利です（すごい！）。また、非常に多機能。 実際、使えるようなドキュメントにするかしないかはコメントを書く人次第だが・・・。 このページでは、コメントの基本的な書き方をサンプルとしてあげる程度に留める。 また、Doxygenは、コメントの書式がいくつかのタイプから選べるが（
無為空間 むいむい(´ω｀*) Entries コールグラフを出してみる（Doxygen） タグ: Doxygen void Z(); void Y(); void X(); void W(); void V(); void U() { Z(); V(); } void T() { Y(); Z(); } void S() { X(); Y(); } void R() { W() ;X(); } void Q() { V(); W(); } void P() { Z(); V(); } void O() { T(); U(); } void N() { S(); T(); } void M() { R(); S(); } void L() { Q(); R(); } void K() { P(); Q(); } void J() { N(); O(); } void I() { M();
クラス図に関して実装依存関係 (継承、所有、クラス参照変数)を生成する場合にチェックします。 COLLABORATION_GRAPH YES
** doxygen みなさんは「doxygen」というツールをご存知でしょうか？ Javaには「Javadoc」というものがありますが、それのC/C++版とでもいえるスバラシイツールです。 ソースにdoxygenに合わせたコメントを記載しておけば、関数仕様書など作成する必要がありません。 Windows、Linux問わず使用できるので、Saborigineer的には試さずにはいられません。 #contents ** doxygenのインストール doxygenのインストールについてはネット上に既に有用な情報がありますので、 ここでの説明は省略します。 詳しくは以下のサイトで。 ・http://www.doxygen.jp/ ・http://www.google.co.jp/search?hl=ja&q=doxygen&btnG=Google+%E6%A4%9C%E7%B4%A2&lr=l
<H2> フレーム関連の警告</H2> <P> このドキュメントはフレーム機能を使って表示するように作られています。フレームを表示できない Web クライアントの場合にこのメッセージが表示されます。 <BR> リンク先<A HREF="overview-summary.html">フレームなしのバージョン</A>
Sandcastle というのは、ソースコードの構造やコメントを元に、ドキュメント(APIや内部説明書)を自動作成してくれるソフトです。 類似のソフトとして、doxygenやNDocがあります。 今回は、Sandcastle と 支援ソフトの Sandcastle Help File Builder の使い方について、簡単に説明します。 まずは概要 Sandcastleには、以下の特徴があります。 MSDN風のHTML Help形式(.chm)のドキュメントを作成してくれます。 .NET 2.0に対応しています。 Microsoft自身が対応してくれています。 VS SDK 4.0 December CTP に同梱されたり、単独で配布しています。 日本語を使っても大丈夫のようです。 Sandcastleについて、先行で調べてらっしゃる方については、以下が参考になると思います。 Kazzzの
他人が Visual Studio 6 で書いたＣ言語のプログラムを読む羽目になり、何が何やらさっぱりなので Doxygen で関数のリストを作ろうと思ったのだが、*.h ファイルのリストしか作られなくて悩んだ。 結局 EXTRACT_ALL を YES にすれば良いのであった。こちらの記事を参考にした。
home 開発に参加したい方へ 仕様検討 内部構造 外部リンク HotTopics └ トリプルクリックDoxygenComment開発に参加したい方へ＞doxygen＞コメントの書き方 Table of Contentsコメントの書き方(クラス・関数のコメント) doxygenで認識されるコメント スタイル コメントの位置 Doxygenへの指示 コマンド 自動的なリンクの作成 具体的なコメントの書き方 ファイル クラス 関数 変数 コメントの書き方(クラス・関数のコメント) ソースコード中のコメントをdoxygenの解説に反映させるためのコメントの書き方です。新規にコメントを入れる場合は以下のルールにできるだけ従うようにしてください。 関数内のコメントはこのルールに従っていただいても意味がありませんので通常のコメントで結構です。ドキュメント生成に関係するのは、 ファイ
Please join the Graphviz forum to ask questions and discuss Graphviz. What is Graphviz? Graphviz is open source graph visualization software. Graph visualization is a way of representing structural information as diagrams of abstract graphs and networks. It has important applications in networking, bioinformatics, software engineering, database and web design, machine learning, and in visual inter
doxygen では、1つの簡易記述と1つの詳細記述だけが許されます。 もし、宣言の前に1つの簡易記述があり、 さらに定義の前にも1つの簡易記述があるとすると、 宣言の前にあるものだけが使用されます。 同様の状況が詳細記述にも生じた場合は、定義の前にあるものが優先され、 宣言の前にあるものは無視されます。 これは、Qt スタイルでドキュメントを記述した、C++ コードの例です: //! A test class. /*! A more elaborate class description. */ class Test { public: //! An enum. /*! More detailed enum description. */ enum TEnum { TVal1, /*!< Enum value TVal1. */ TVal2, /*!< Enum value TVa
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
