質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.50%
XML

XMLは仕様の1つで、マークアップ言語群を構築するために使われています。

C#

C#はマルチパラダイムプログラミング言語の1つで、命令形・宣言型・関数型・ジェネリック型・コンポーネント指向・オブジェクティブ指向のプログラミング開発すべてに対応しています。

Q&A

解決済

1回答

434閲覧

C#のXMLDocumentsはどこに挿入すべきでしょうか

退会済みユーザー

退会済みユーザー

総合スコア0

XML

XMLは仕様の1つで、マークアップ言語群を構築するために使われています。

C#

C#はマルチパラダイムプログラミング言語の1つで、命令形・宣言型・関数型・ジェネリック型・コンポーネント指向・オブジェクティブ指向のプログラミング開発すべてに対応しています。

0グッド

1クリップ

投稿2017/10/10 08:45

C#のXML Documentにつきまして,<summary>等がコメントとしてとても見やすいため使用しているのですが,一般的にはどこに挿入される物なのでしょうか.
(例:全てのクラス,publicなメンバ 等)

privateなメンバについては,外部に公開されないため,挿入すべきではないのでしょうか.
その場合,どのような形でコメントが入れられるのでしょうか.

独学でプログラミングを学んでいるため,一般的にどのように行われているのか気になり,質問いたしました.
ご回答よろしくお願いいたします.

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答1

0

ベストアンサー

個人的な運用について記載します。

一般的にはpublicとなっているものだと認識しています。(XMLを出力する設定にすると、publicに対してXMLコメントがない場合、ビルド時に警告が発生するが、private等については発生しない)
しかし、私の場合は、自動生成の部分は除いてすべてのメソッド、すべてのクラスに対して記載していました。

理由は、そのメソッドの存在意義・説明を書くことができるためです。
そのため、使用上の注意点も併せて記載するようにしています。(hoge()メソッドを呼んでからじゃないと使えない/スレッドセーフ等)
メソッド内部の処理についてはremarksタグ内に書くと、そのメソッドを次回変更するときに役に立ちます。

利用価値については以下の通りです。
Visual Studioを使用している場合、補完時等で表示され、実装時のヒントになります。
DoxygenやSandcastle(?)等でドキュメントの自動生成ができます。
外部提供時はAPIドキュメントと合わせて提供できるようにしています。

投稿2017/10/12 17:29

testset

総合スコア221

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

退会済みユーザー

退会済みユーザー

2017/10/13 05:40

ご回答ありがとうございます! 参考にさせて頂きます.
guest

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.50%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問