C# と VB.NET の質問掲示板
ASP.NET、C++/CLI、Java 何でもどうぞ
掲示板トップ
C# と VB.NET 入門
新規作成
利用方法
ツリー表示
トピック表示
ランキング
記事検索
過去ログ
ログ内検索
キーワードを複数指定する場合は 半角スペース で区切ってください。
検索条件は、(AND)=[A かつ B] (OR)=[A または B] となっています。
[返信]をクリックすると返信ページへ移動します。
キーワード
/
検索条件
/
(AND)
(OR)
検索範囲
/
(現在のログ)
(全過去ログ)
(過去ログ1)
(過去ログ2)
(過去ログ3)
(過去ログ4)
(過去ログ5)
(過去ログ6)
(過去ログ7)
(過去ログ8)
(過去ログ9)
(過去ログ10)
(過去ログ11)
(過去ログ12)
(過去ログ13)
(過去ログ14)
(過去ログ15)
(過去ログ16)
(過去ログ17)
(過去ログ18)
(過去ログ19)
(過去ログ20)
(過去ログ21)
(過去ログ22)
(過去ログ23)
(過去ログ24)
(過去ログ25)
(過去ログ26)
(過去ログ27)
(過去ログ28)
(過去ログ29)
(過去ログ30)
(過去ログ31)
(過去ログ32)
(過去ログ33)
(過去ログ34)
(過去ログ35)
(過去ログ36)
(過去ログ37)
(過去ログ38)
(過去ログ39)
(過去ログ40)
(過去ログ41)
(過去ログ42)
(過去ログ43)
(過去ログ44)
(過去ログ45)
(過去ログ46)
(過去ログ47)
(過去ログ48)
(過去ログ49)
(過去ログ50)
(過去ログ51)
(過去ログ52)
(過去ログ53)
(過去ログ54)
(過去ログ55)
(過去ログ56)
(過去ログ57)
(過去ログ58)
(過去ログ59)
(過去ログ60)
(過去ログ61)
(過去ログ62)
(過去ログ63)
(過去ログ64)
(過去ログ65)
(過去ログ66)
(過去ログ67)
(過去ログ68)
(過去ログ69)
(過去ログ70)
(過去ログ71)
(過去ログ72)
(過去ログ73)
(過去ログ74)
(過去ログ75)
(過去ログ76)
(過去ログ77)
(過去ログ78)
(過去ログ79)
(過去ログ80)
(過去ログ81)
(過去ログ82)
(過去ログ83)
(過去ログ84)
(過去ログ85)
(過去ログ86)
(過去ログ87)
(過去ログ88)
(過去ログ89)
(過去ログ90)
(過去ログ91)
(過去ログ92)
(過去ログ93)
(過去ログ94)
(過去ログ95)
(過去ログ96)
(過去ログ97)
(過去ログ98)
(過去ログ99)
(過去ログ100)
(過去ログ101)
(過去ログ102)
(過去ログ103)
(過去ログ104)
(過去ログ105)
(過去ログ106)
(過去ログ107)
(過去ログ108)
(過去ログ109)
(過去ログ110)
(過去ログ111)
(過去ログ112)
(過去ログ113)
(過去ログ114)
(過去ログ115)
(過去ログ116)
(過去ログ117)
(過去ログ118)
(過去ログ119)
(過去ログ120)
(過去ログ121)
(過去ログ122)
(過去ログ123)
(過去ログ124)
(過去ログ125)
(過去ログ126)
(過去ログ127)
(過去ログ128)
(過去ログ129)
(過去ログ130)
(過去ログ131)
(過去ログ132)
(過去ログ133)
(過去ログ134)
(過去ログ135)
(過去ログ136)
(過去ログ137)
(過去ログ138)
(過去ログ139)
(過去ログ140)
(過去ログ141)
(過去ログ142)
(過去ログ143)
(過去ログ144)
(過去ログ145)
(過去ログ146)
(過去ログ147)
(過去ログ148)
(過去ログ149)
(過去ログ150)
(過去ログ151)
(過去ログ152)
(過去ログ153)
(過去ログ154)
(過去ログ155)
(過去ログ156)
(過去ログ157)
(過去ログ158)
(過去ログ159)
(過去ログ160)
(過去ログ161)
(過去ログ162)
(過去ログ163)
(過去ログ164)
(過去ログ165)
(過去ログ166)
(過去ログ167)
(過去ログ168)
(過去ログ169)
(過去ログ170)
(過去ログ171)
(過去ログ172)
(過去ログ173)
(過去ログ174)
(過去ログ175)
(過去ログ176)
(過去ログ177)
(過去ログ178)
(過去ログ179)
強調表示
/
ON
(自動リンクOFF)
結果表示件数
/
20件
30件
40件
50件
100件
記事No検索
/
ON
大文字と小文字を区別する
No.57388 の関連記事表示
ヒット / 11件
(1-11 を表示)
<<
0
>>
■57388
最近のC#のドキュメントの作り方
□投稿者/ めめ -
(2011/02/24(Thu) 17:32:52)
分類:[C#]
2011/02/24(Thu) 17:34:46 編集(投稿者)
2011/02/24(Thu) 17:33:45 編集(投稿者)
コメントの書き方、書いたコメントのドキュメント化について質問です。
JavaではJavaDocという有名で簡単なドキュメントの作り方があると思います。
FlexなどのActionScriptの場合はASDocというJavaDocもどきを簡単に作成することができます。
“最近”のC#のコメントは、この辺りはどのようになっているのでしょうか?
(最近、ASDocなどはバージョンが上がり、サポートファイルが増えるなどの変化もありましたので)
自分なりに調べてみた所、XMLドキュメントを書くのが基本なのかなと感じました。(参考1)
しかし、これ単体ではただのXMLファイルであるだけで、分かりやすいドキュメントにはなりそうにありません。
他言語が基本フリーでドキュメントができるのもあって、C#でもフリーでよく使われるものを探しています。
(古いVisualStudioではドキュメント化できるような記述もありましたが、現在はありませんでした。(参考2))
(また、参考1ではサンドキャッスルというツールが挙げられていました)
探した記事が少し古めというのもあって、今現在、なにが主流の手法になっているのか確信を持てないでいます。
.Net4と合わせて、VisualStudioでもツールをダウンロードできるようになっているのもあって、
いろいろ変化していそうですし、そっちでツールを決めることもできそうという懸念もあります。
なにか小ネタでも構いません。この辺り分かる方いましたら、返信頂けると助かります。
よろしくお願いします。
環境
Windows7 Professional x64
VisualStudio 2010 Professional
参考
1
http://msdn.microsoft.com/ja-jp/library/b2s063f7
2
http://www.atmarkit.co.jp/fdotnet/teamdev/teamdev02/teamdev02_01.html
親記事 /過去ログ96より /
関連記事表示
削除チェック/
■57397
Re[1]: 最近のC#のドキュメントの作り方
□投稿者/ やじゅ -
(2011/02/24(Thu) 21:46:47)
>
■
No57388
(めめ さん) に返信
やはり、フリーだと Sandcastle くらいなんじゃないかな。
http://d.hatena.ne.jp/aoki1210/20110108
http://d.hatena.ne.jp/Csh/20100315/1268663023
支援ツールとして、XMLドキュメントコメントの雛型生成 アドイン
GhostDoc
http://submain.com/products/ghostdoc.aspx
Atomineer Utils Pro Documentation
http://visualstudiogallery.msdn.microsoft.com/7912CCF4-60B8-4132-BACE-5ACACEB7233B/
記事No.57388 のレス /過去ログ96より /
関連記事表示
削除チェック/
■57402
Re[2]: 最近のC#のドキュメントの作り方
□投稿者/ めめ -
(2011/02/25(Fri) 10:30:37)
>>やじゅ さん に返信
Sandcastleについて、もう少し調べてみた…というか作成してみました。
ドキュメントの出来自体は十分かと思うのですが、それ単体では実行することが叶いませんでした。
しかたなく、SandcastleHelpFileBuilderの力を借りて書き出しています。
ただ、これだとVisualStudioで完結していません。
わざわざ別のツールを立ち上げるのが、手間というか情けなく感じてしまいます。
Eclipseではアドインの強みもあるのでしょうが、フリーのツールで容易くできることが、
なぜVisualStudioでは未だにこれほど手間が必要になるのか、とても不思議です。
VisualStudioだけで、ドキュメント化は完結できないのでしょうか?
記事No.57388 のレス /過去ログ96より /
関連記事表示
削除チェック/
■57415
Re[3]: 最近のC#のドキュメントの作り方
□投稿者/ PATIO -
(2011/02/25(Fri) 14:02:37)
■
No57402
(めめ さん) に返信
> ただ、これだとVisualStudioで完結していません。
>
> わざわざ別のツールを立ち上げるのが、手間というか情けなく感じてしまいます。
> Eclipseではアドインの強みもあるのでしょうが、フリーのツールで容易くできることが、
> なぜVisualStudioでは未だにこれほど手間が必要になるのか、とても不思議です。
>
> VisualStudioだけで、ドキュメント化は完結できないのでしょうか?
私が知らないだけかもしれませんが、VisualStudioの環境でソースからドキュメントを
起こすという方向でのアプローチは見た事がありません。
RADツール系の物は見た事があると思いますが、おそらく言われている物とは
別の物だと思うので参考になりませんよね。
私の場合、C#ではなくてC++なのでdoxygenを使っていますが、
それに関して特に不満はありません。
私の場合、ソースからドキュメントを起こすのではなくて
設計書を作成してコーディングするというスタイルなので
ソースを記述する時は基本的に設計書がある事が前提になっています。
そんなこんなでその方向のアプローチを必要としていないからです。
記事No.57388 のレス /過去ログ96より /
関連記事表示
削除チェック/
■57425
Re[3]: 最近のC#のドキュメントの作り方
□投稿者/ aetos -
(2011/02/25(Fri) 17:06:11)
■
No57402
(めめ さん) に返信
> VisualStudioだけで、ドキュメント化は完結できないのでしょうか?
「Support for full Visual Studio integration is planned for a future release. 」だそうです。
http://shfb.codeplex.com/
*.shfbproj ファイルは MSBuild でビルドできますから、一度 GUI でプロジェクトファイルを作った後は、VS のビルド イベントに登録しておけば自動化できます(ビルド時間はかなり伸びますが)。
ただ、ソリューションのビルドをすべて終えた後のアクションというのはありませんので、ソリューション内でのプロジェクト依存関係で最後にビルドされるプロジェクトのビルド イベントに仕込む必要があるでしょう。
記事No.57388 のレス /過去ログ96より /
関連記事表示
削除チェック/
■57480
Re[4]: 最近のC#のドキュメントの作り方
□投稿者/ めめ -
(2011/03/01(Tue) 10:25:45)
PATIOさん
>私の場合、C#ではなくてC++なのでdoxygenを使っていますが、それに関して特に不満はありません。
>私の場合、ソースからドキュメントを起こすのではなくて
>設計書を作成してコーディングするというスタイルなので
>ソースを記述する時は基本的に設計書がある事が前提になっています。
>そんなこんなでその方向のアプローチを必要としていないからです。
なるほど。私的にはありなのかもしれません。
しかし、私は仕様書とプログラムのドキュメントは根本的に用途は別だと思います。
確かに、ソースを記述する時にドキュメントが必要であることはないですが、成果物として残すと残さないのでは、だいぶ違うと思います。
特にライブラリ系を作りだすと、関数のリファレンスは絶対に必要だと思います。
あまり使わないのでどのクラスだったか覚えていない。ソースで探す、あるいは作り直す。なんていうのはちょっと情けないかなぁ、と。
C#は好きな言語だし、アンチする意図はなかったのですが、
まさかそういった機能を未だに標準で備えていないのは驚きでした。
■
No57425
(aetos さん) に返信
>>VisualStudioだけで、ドキュメント化は完結できないのでしょうか?
> 「Support for full Visual Studio integration is planned for a future release. 」だそうです。
なるほど、今後サポートされる可能性はあるかもしれないのですね。
>
http://shfb.codeplex.com/
> *.shfbproj ファイルは MSBuild でビルドできますから、一度 GUI でプロジェクトファイルを作った後は、VS のビルド イベントに登録しておけば自動化できます(ビルド時間はかなり伸びますが)。
> ただ、ソリューションのビルドをすべて終えた後のアクションというのはありませんので、ソリューション内でのプロジェクト依存関係で最後にビルドされるプロジェクトのビルド イベントに仕込む必要があるでしょう。
ビルドイベントに登録ですか。そういう手法があるのですね。
現状一番スマートな感じですが、重たくはなりそうです。
しかし、ドキュメントがここまで未整理のままだとは思いもしませんでした。残念です。
記事No.57388 のレス /過去ログ96より /
関連記事表示
削除チェック/
■57496
Re[5]: 最近のC#のドキュメントの作り方
□投稿者/ PATIO -
(2011/03/01(Tue) 18:14:18)
2011/03/01(Tue) 18:20:18 編集(投稿者)
■
No57480
(めめ さん) に返信
>
> PATIOさん
> >私の場合、C#ではなくてC++なのでdoxygenを使っていますが、それに関して特に不満はありません。
> >私の場合、ソースからドキュメントを起こすのではなくて
> >設計書を作成してコーディングするというスタイルなので
> >ソースを記述する時は基本的に設計書がある事が前提になっています。
> >そんなこんなでその方向のアプローチを必要としていないからです。
>
> なるほど。私的にはありなのかもしれません。
> しかし、私は仕様書とプログラムのドキュメントは根本的に用途は別だと思います。
> 確かに、ソースを記述する時にドキュメントが必要であることはないですが、成果物として残すと残さないのでは、だいぶ違うと思います。
> 特にライブラリ系を作りだすと、関数のリファレンスは絶対に必要だと思います。
いえいえ、関数リファレンスも作成します。
ただ単に関数リファレンスをソースのコメントから自動で起こさないというだけの話です。
ですから、成果物として作成することには変わりありません。
基本的にはクラス設計書を元にクラスリファレンスを起こしたりしています。
必要な成果物と言うのはどういう作成方法を取るにしても変わりありません。
ただ、方法論的な違いだけだと思います。
私の場合、自動的に吐き出された資料では相手先がOKをくれないケースが
多かったので大抵の場合、手で起こしていました。
記事No.57388 のレス /過去ログ96より /
関連記事表示
削除チェック/
■57513
Re[5]: 最近のC#のドキュメントの作り方
□投稿者/ aetos -
(2011/03/02(Wed) 15:01:37)
■
No57480
(めめ さん) に返信
> しかし、ドキュメントがここまで未整理のままだとは思いもしませんでした。残念です。
実はねぇ、VS2003 あたりでは確かあったんですよね。HTML を生成する機能が。
「Webページのビルドコメント」とかいう、変な名前の機能でね。
2005 からなくなったんだと思います。
なんでだろうね。
記事No.57388 のレス /過去ログ96より /
関連記事表示
削除チェック/
■57514
Re[6]: 最近のC#のドキュメントの作り方
□投稿者/ マサヤ -
(2011/03/02(Wed) 15:13:38)
JavaDocを出されると条件反射でHotDocを上げるのは私だけでしょうか?
http://www.hotdocument.net/faq/man.html
無料ではないので、なんともいえませんが。
記事No.57388 のレス /過去ログ96より /
関連記事表示
削除チェック/
■57531
Re[5]: 最近のC#のドキュメントの作り方
□投稿者/ よねKEN -
(2011/03/03(Thu) 12:29:10)
■
No57480
(めめ さん) に返信
> ビルドイベントに登録ですか。そういう手法があるのですね。
> 現状一番スマートな感じですが、重たくはなりそうです。
ビルドイベントではなく、外部ツールにコマンドとして登録してはいかがでしょう。
ビルド時に毎回生成するのは無駄が多いように思いますし。
#どのように登録するかとか、実際に登録できるのかとかは検証していません。アイデアだけです
記事No.57388 のレス /過去ログ96より /
関連記事表示
削除チェック/
■57535
Re[6]: 最近のC#のドキュメントの作り方
□投稿者/ PATIO -
(2011/03/03(Thu) 13:56:23)
今調べて見て気が付いたんですけれど、
doxygenってC#にも対応しているみたいですね。
あんまりじっくり見てなかったから知りませんでしたけれど。
記事No.57388 のレス /過去ログ96より /
関連記事表示
削除チェック/
<<
0
>>
パスワード/
-
Child Tree
-