2011-02-16 12 views
0

"// TODOは完全なクラスヘッダを実装しています"私のC#クラスの最終プロジェクトではプロジェクトのTODOの1つです。私はそれが何を意味するかは完全にはわかりません。"// TODOは完全なクラスヘッダを実装しています"

それはこのようになります含まれているプログラムの先頭:別の開発者がクラス/含まれないものを知っているような情報を指定し

using System; 
using System.Collections.Generic; 
using System.Linq; 
using System.Text; 

//TODO implement a complete class header 

namespace Payroll 
{ 


[Serializable] 


    public abstract class Employee:IPayable 
    { 
     #region "Variable Declarations" 

     //create an enumeration that keeps track of the type 
     public enum Type 
     { 
      Hourly = 1, 
      Salary = 2, 
      Contract = 3, 
      None = 4 
     }; 
+1

約5下さい以上、または1非常に少なくとも、私たちのコードのいくつかのより多くの行を表示。それとも、あなたが持っているものはどれですか? – servermanfail

+1

ええ、C#ではそのようなことはありません。また、(名前空間の外側の)TODOの位置は奇数です。あなたのインストラクターは、クラスにXMLコメントを追加することを意味するかもしれません(クラス定義の上に '///'をタイプすることで簡単に行うことができます)。 – MusiGenesis

答えて

6

hereについては、<summary>タグについて詳しく知ることができます。

Recommended Tags for Documentation Comments

はまたGhostDocと呼ばれるいくつかのソフトウェアを使用することができます。

GhostDocは、自動的にXMLドキュメント 方法のためのコメントとそのタイプに基づいて 性質、 パラメータ、名前、および他のコンテキスト 情報を生成Visual Studioの拡張 です。

関連する問題