ソースコードからドキュメントをDoxygenで生成する
新トップページへ ｜ Ｔｉｐ ソースコードからドキュメントをDoxygenで生成する LastUpdate : 13/01/02 JavaDoc的なことをC++でもやろう、という話です。 正直、JavaDocで生成したHTMLを見て役に立ったことがあまり有りませんが、コメントを書く際の統一的な書式としては役に立つと思います。 もくじ はじめに Doxygenのインストール コメントの書式 ドキュメントを生成する はじめに 詳細はこちら(http://www.doxygen.jp/)を参照。 日本語サイトがあるので、非常に便利です（すごい！）。また、非常に多機能。 実際、使えるようなドキュメントにするかしないかはコメントを書く人次第だが・・・。 このページでは、コメントの基本的な書き方をサンプルとしてあげる程度に留める。 また、Doxygenは、コメントの書式がいくつかのタイプから選べるが（
Doxygen対応Cプログラムコメント記述例ご紹介
投稿日：2012/08/26 作成者：TZ 弊社でのC言語で開発を行うプロジェクトでは、ソフトウェア詳細設計書にDoxygenで出力したデータを用いるため、必要な情報を出力するためのコメント記述をしております。 今回は弊社で用いるタグコメントの書き方について紹介させて頂きます。 実際にはDoxygenのオプション設定などにより別の記述もございますので、詳しくはDoxygenのサイトを参照頂ければと思います。 Doxygen設定(doxyfile) 良く使う基本的な設定は以下となります。 OUTPUT_LANGUAGE = Japanese RECURSIVE = YES JAVADOC_AUTOBRIEF = YES OPTIMIZE_OUTPUT_FOR_C = YES はじめに Doxygenのコメントブロックを記述する場合 /** * ...各種コメント記述... */ または //
Doxygen：コードのドキュメント付け
コードのドキュメント付け 特殊ドキュメント・ブロック 特殊ドキュメント・ブロックは、C または C++スタイルのコメントブロックにマークを付け加えたもので、Doxygenはこれをドキュメント断片と認識して、ドキュメントを生成します。 PythonとVHDLコードについては、別のコメント表記規則があります。セクションPython での特殊ドキュメント・ブロック と VHDL での特殊ドキュメント・ブロック で説明します。 各コード要素について、説明形式が2（3の場合も）種類あり、これらがドキュメントを形成します。それは、要約説明と 詳細説明で、どちらもオプションです。メソッドと関数については、もうひとつの形式があり、いわゆる"本文内"説明で、メソッドや関数の本体内のコメントブロックの連結からなります。 ひとつ以上の要約説明または詳細説明を指定できます。（ただし、出現順序が指定されていないため
Doxygen - 特殊コマンド
特殊コマンド はじめに ドキュメント内のすべてのコマンドは、バックスラッシュ (\)、 またはアットマーク (@) で始まります。 お望みであれば、以下のバックスラッシュで始まるすべてのコマンドを、 それに対応したアットマークで始まるものに置き換えることができます。 いくつかのコマンドは、1つまたはそれ以上の引数を取ります。 各引数には、ある決まった範囲があります: <山> 括弧が使われている場合、引数は 1単語からなります。 (丸) 括弧が使われている場合、引数は、コマンドのある場所からその行の終わりまでとなります。 {波} 括弧が使われている場合、引数は、次のパラグラフの頭までとなります。 パラグラフは、空行かセクション指示子で区切られます。 [角] 括弧が使われている場合、引数は省略可能です。 以下は、全コマンドをアルファベット順に整列したリストです (説明への参照付き)。
太陽光発電の設置角度、方位方角を理解して発電量や効率を最大化する
南向き以外でもよりメリットを高めるには 屋根の向きが決まっている場合などは南向きに設置できないこともあります。屋根は片流れ屋根でない限り2面以上あるのが通常ですが、いずれかの面が少しでも南に偏っているのであればそちらの面にパネルを載せるのが正解です。例えば北西と南東に2面ある屋根の場合は南東面に設置すると、大きく発電量を損ねるリスクが低くなります。 南からどれくらい方向がずれるとどれくらいの発電量ロスに繋がるのかは、設置角度にもよります。詳しくは以下の項でご案内していますが、東や西よりも北側に寄らない限り発電量のロス率は10%未満で抑えられる可能性が高いと言えます。 西と東の2面に屋根が分かれている際は両方に付けるという選択肢もありますが、1面でも4kW以上が載る場合は片面だけ載せて初期費用を抑えることもできます。この場合、特に夏場に気温が高くなりがちな夕焼けの時間帯に発電する西側よりも、
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
