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

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

ただいまの
回答率

90.98%

  • C#

    5794questions

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

  • XML

    591questions

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

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

解決済

回答 1

投稿

  • 評価
  • クリップ 1
  • VIEW 213

takano20771

score 32

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

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

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

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

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

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

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

checkベストアンサー

+1

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

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

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

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2017/10/13 14:40

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

    キャンセル

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

  • ただいまの回答率 90.98%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

  • 受付中

    スタートアップ(新興企業)における日報に関して

    お世話になっております。 このサービス内で質問する内容とは直接関係ないかもしれませんが、 企業で勤務されている皆様にお聞きしたいことがあります。 それは、皆様方の勤め先では、「日

  • 受付中

    eclipseのエラー?

    ヘッダーファイルで コンスト デストラクタ メンバー メンバー 続く という順番で書いたところ、実装ファイルでメンバーが見つかりませんと言われて、試しにデストラクタを一番下に切り取

  • 受付中

    Windows Formアプリケーションが終了できない。

    C# でWindows Formのアプリケーションを作成するにあたり、スレッドを使用するために、  ひとまずプロトとして、プログレスバーの表示を変化させている最中にボタンをクリッ

  • 受付中

    The name `playerTransform' does not exist in the c...

    Assets/Script/EvasiveManeuver.cs(21,17): error CS0103: The name `playerTransform' does not

  • 解決済

    C#のフォームの表示と非表示について

    分からないこと・実現したいこと ボタンをクリックすると、現在表示しているフォームを閉じ、別のフォームを開くが、プロジェクトを終了しないという方法はありますか? 作成中のプロ

  • 解決済

    C++で///を使ったコメント

    C++関係ないのかもしれませんが、最近コメント文で///とスラッシュを三つ使ったものをよく見ます。 VS2015で///を使うと//や/**/より濃い緑色になるのにも最近気が付き

  • 解決済

    AndroidStudioでの取得した値の取り扱い方

    前提・実現したいこと Android Studioで取得した値の取り扱い方についてです。 発生している問題・エラーメッセージ 下記のプログラムで座標を取り出しました。

  • 解決済

    フォームで入力されたものがデータベースに反映されない

    前提・実現したいこと visualstudioにて、簡単なフォームアプリを作っています。 今までjavaばかりやっていたので、C#でのデータベースとのやりとりでつまづいています。

同じタグがついた質問を見る

  • C#

    5794questions

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

  • XML

    591questions

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