コーディング規約 トップページ > C# コーディング規約 目次

1.7 Namespace/Interface/構造体/Enumのコメント

Namespace/Interface/構造体/Enumに関するコメントは、以下のように記述する。
宣言の後にコメントを記述すると、各ドキュメントの説明に出力される。

■Namespaceのコメント例

namespace Sample // Form1の名前空間
{
　・・・
}

■Interfaceのコメント例

　public interface InterSample // interfaceコメント
　{
　　event MyDelegate MyEvent1; // MyEvent1コメント
　　event MyDelegate MyEvent2; // MyEvent2コメント
　}

■構造体のコメント例

　public struct PERSON // structコメント
　{
　　string Name; 　// 名前
　　int Age; 　　　 // 年齢
　}

■Enumのコメント例

　public enum WeekDay // enumコメント
　{
  　Sun = 1,　　// 日曜日
  　Mon = 2,　　// 月曜日
  　Tue = 3,　　// 火曜日
  　Wed = 4,　 // 水曜日
  　Thu = 5,　 // 木曜日
  　Fri = 6,　　// 金曜日
  　Sat = 7,　 // 土曜日
　}