8

最近、Visual Studio (2010) で (C#) プロジェクトを作成し、いくつかの設定 (プロパティで作成したもの) を使用しました。

ドキュメントに XML コメントを追加できる唯一の場所は、Settings.Designer.cs です。ただし、このファイルは自動生成されるため、設定を変更するたびにコメントが表示されなくなります。

Visual Studio でさえ、「宣伝用の XML コメントが見つからないタイプまたはメンバー ....」という警告を出し始めました。

私の質問は次のとおりです。設定に XML コメントを追加する最も適切な方法は何ですか?

  • Settings.Designer.cs よりも優れた場所はありますか?
  • ファイルの自動生成を停止する必要がありますか? どのように？
  • その他の方法で？

ちなみに私はSandcastle Help File Builderを使っています

4

3 に答える 3

10

(既定のデザイナーを使用して) 設定を開くと、プロパティ ウィンドウのプロパティ "説明" で見つけることができます。入力すると、自動生成されたファイルで XML コメントの要約として使用されます。

于 2010-09-22T06:50:32.800 に答える
2

Settings.settings ファイル (デザイナーで開かないでください) で、「説明」などの属性を追加します。

<Setting Name="MySetting" Description="This property does blah blah blah" Type="System.Int32" Scope="Application">
  <Value Profile="(Default)">42</Value>
</Setting>

これにより生成されます

/// <summary>
/// This property does blah blah blah
/// </summary>
[global...]
public int MySetting { ...

Settings.settings ファイルを使用して MAML トピック ファイルを作成するツールを構築することもできます。プロジェクトのビルド イベントでツールを呼び出すと、出来上がりです。

私のテストでは、説明を設定要素の属性として配置すると、デザイナで設定を変更すると、属性が保持されます。ただし、Setting 要素の子として配置すると、削除されます。

于 2012-12-13T20:51:56.860 に答える
0

それをやった。もっと良い方法があるかどうかはまだわかりませんが、Sandcastle HFB プロジェクトに SettingsDoc.xml を追加しました。欠点は、Visual Studio によってコンパイルされないことです。そのため、参照などを自分で更新および確認する必要があります。

于 2010-05-25T12:59:54.377 に答える