"// TODO реализует полный заголовок класса"

Question

"// TODO реализует полный заголовок класса", работающий над моим последним проектом для моего класса C #, и это один из 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
        };

Answer 1

Укажите информацию, чтобы другой разработчик знал, что класс делает / содержит.

Более подробную информацию можно получить здесь о <summary> тегах.

Рекомендуемые теги для комментариев к документации

Вы также можете использовать программное обеспечение под названием GhostDoc .

GhostDoc - это расширение Visual Studio, которое автоматически генерирует документацию XMLкомментарии к методам и свойствам на основе их типа, параметров, имени и другой контекстной информации.

Answer 2

Возможно, просто ссылается на добавление заголовка документации в класс: http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

Answer 3

Возможно, он или она ссылались на комментарий к документации XML , который им еще не нужно было писать.