SAKURA Editor / Wiki / DoxygenComment
開発に参加したい方へ＞doxygen＞コメントの書き方 コメントの書き方(クラス・関数のコメント) ソースコード中のコメントをdoxygenの解説に反映させるためのコメントの書き方です。新規にコメントを入れる場合は以下のルールにできるだけ従うようにしてください。 関数内のコメントはこのルールに従っていただいても意味がありませんので通常のコメントで結構です。ドキュメント生成に関係するのは、 ファイル クラス メンバー関数（Inline含む） メンバー変数 グローバル変数 クラスのメンバーでない関数 定数宣言 (#define, enum) です。 doxygenで認識されるコメント スタイル doxygenではQtスタイル及びJavaDocスタイルのコメントを認識します．コメントには要約説明（クラス一覧やクラスメンバーのサマリー部にも表示されるもの）と詳細説明（各関数の説明部のみに出力される
【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はすべてのコメントをドキュメント化するのではなく、特定の形式で記述されたコメントのみ
NGUI: Next-Gen UI kit: Class List
This improved version of the System.Collections.Generic.List that doesn't release the buffer on Clear(), resulting in better performance and less garbage collection. PRO: BetterList performs faster than List when you Add and Remove items (although slower if you remove from the beginning). CON: BetterList performs worse when sorting the list. If your operations involve sorting, use the standard Lis
NGUI のプログラムを元にオフラインでも使えるAPIリファレンスを作る方法 - 強火で進め
Unity Advent Calendar 2012、8日目のMikamiさんに続いて9日目を担当させて頂く @nakamura001 です。よろしくお願いします。 折角のイベント事ですからちょっと毛色の違うUnityネタを書こうかと思います。内容は「オフラインでもガリガリUnityプログラムが出来る様にリファレンスを整備しよう」というものです。これでネット環境が無い場所でのプログラムも怖くない!! 作成するリファレンスのフォーマット解説 NGUI のプログラム書き込まれているドキュメンテーションコメントを元にリファレンス(chmファイルやdocsetファイル)を作成する方法を解説します。 ちなみにchmファイルはこんなアイコンのファイルで、Windowsでよく使われる一般的なヘルプファイルです。 docset とは Mac で使われるAPIのリファレンスなどヘルプファイル的な用途に使われ
【Unity】UnityでDoxgenとGraphvizを使う - The jonki
Unityでクラス図とかドキュメントとかって皆さんどうしてるんですかね。入用だったので環境を整えてみました。ありがたいことにDoxygenのUnityプラグインを公開している人がいたのでそれを使います。 今回の環境 Unity 4.3 Windows 7 準備 Doxygenのインストール Doxygenのページからインストーラーを落としてくる。今回はdoxygen-1.8.6-setup.exeでした。デフォルトの設定でインストールで問題なし。 Graphvizのインストール Graphvizのページからインストーラーを落としてきてインストール。こちらもデフォルトの設定でOK。 DoxygenForUnityプラグインのダウンロード このページから「You can download it here.」のhereの部分がリンクになっているので、そこからダウンロード。 UnityにDoxyg
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Loading...
