【c++】関数の仕様を出力

質問

クラス内で作成している各関数の仕様をファイルとして出力したいです。

Visual studioを使っていると、
ツールで「クラスビュー」や「オブジェクトブラウザ」などで関数の仕様などが出力されると思います。

Visual studio の機能でも、外部ツールの機能でも良いです。

回答No.3

Tacosan · ベストアンサー

使ったことないけど
http://sourceforge.jp/projects/sfnet_cproto/
みたいなこと?

お礼

ありがとうございます。

（挫折中ですが、お礼だけ。）
なんとかうまく使ってみようと思います。

補足

ありがとうございます。

ダウンロードしてみました。
（使い方がまだよくわかっていないところです。）

.hのファイルがいくつか入っていて、
readMeを読む限り、

windowsの場合、watcom.makというmakeファイルっぽいのを実行するっぽいのです。

きっと実行パラメータに、対象となる関数が書かれてあるcppのディレクトリあたりを指定して実行すると思われますが、そこまで至ってないです。

回答No.2

Picosoft

///<summary>累乗を計算する</summary>
///<param name='d'>計算対象</param>
///<returns>dの累乗</returns>
double Pow(double d){
　return d * d;
}
……という感じにコメントをつけ、/docオプションをつけてビルドすると、
出力先のフォルダにxmlファイルができます。
<?xml version="1.0"?>
<doc>
<assembly>
"Test"
</assembly>
<members>
<member name="M:Pow(System.Double)">
<summary>累乗を計算する</summary>
<param name="d">計算対象</param>
<returns>計算結果</returns>
</member>
</members>
</doc>

使ったことはないですが、Doxygenも役に立つかと思います。
http://www.doxygen.jp/

お礼

ありがとうございます。

自分の目的なのですが、
「人為的ミスが起こることなく、関数の引数と、戻り値を出力したい」ということなのです。

Doxygenは使っています。とても便利です。
しかし、その際
@param [in] l_value Long型 出力したい値
@param [in] str_value Long型 出力したいメッセージ
@return long 戻り値
0 正常
-1 異常

とかのように記述しておき、出力されます。
なので、結局、記述を忘れたり、確認をおろそかにすると、
全く意味のないもの、下手したら誤認の原因になってしまうのです。

引数などの論理的意味や、関数名（和名・論理名）は、doxygenを使うつもりですが、
(1)関数の引数
(2)戻り値
(3)関数名　は、そのまま事実を出力したいのです。
.

回答No.1

Picosoft

この辺が参考になるかと思います。
http://msdn.microsoft.com/ja-jp/library/ms177227.aspx
http://msdn.microsoft.com/ja-jp/library/ms173501.aspx

お礼

ありがとうございました。
（No2だけしかお礼してませんでした。。
　「XML ドキュメント ファイルの生成」
　うまく使えば、ドキュメント作成工数が減らせそうですね！）

補足

プロジェクトの [プロパティ ページ]
　⇒　[構成プロパティ]
　⇒　[C/C++]
　⇒　[出力ファイル] のプロパティ ページ
　⇒　[XML ドキュメント ファイルの生成] で設定を変更してみたら、
ファイルとして出力されるのかなと読み取ったのですが、
やってみても出力されるというわけではないのでしょうか？

もし具体的な出力方法などをご存知でしたらご教授頂けませんでしょうか？
.