次の方法で共有


コンパイラの警告 (レベル 1) CS1570

更新 : 2007 年 11 月

エラー メッセージ

'コンストラクト' の XML コメントの形式が正しくありません — '理由'

/doc を使用するときは、ソース コードに含まれるコメントを XML 形式にする必要があります。XML マークアップが付いたエラーがあると、警告 CS1570 が生成されます。次に例を示します。

  • <exception> タグなどで cref に文字列を渡す場合は、その文字列を二重引用符で囲む必要があります。

  • 終了タグのない <seealso> などのタグを使用する場合は、右山かっこの前にスラッシュを付ける必要があります。

  • 記述するテキストの中で不等号 (より大) または不等号 (より小) を使用する場合は、それぞれ &gt; および &lt; で表す必要があります。

  • <include> タグのファイル属性またはパス属性が見つからなかったか、または不適切な形式になっていました。

次の例では警告 CS1570 が生成されます。

// CS1570.cs
// compile with: /W:1
namespace ns
{
   // the following line generates CS1570
   /// <summary> returns true if < 5 </summary>
   // try this instead
   // /// <summary> returns true if &lt;5 </summary>

   public class MyClass
   {
      public static void Main ()
      {
      }
   }
}