Следует ли писать XML-комментарии для интерфейсов, конкретных реализаций или того и другого? [закрыто]

Закрыт . Этот вопрос основан на мнении . В настоящее время он не принимает ответы.

Хотите улучшить этот вопрос? Обновите вопрос, чтобы на него можно было ответить с помощью фактов и цитат, отредактировав это сообщение .

Закрыт в прошлом году .

Меня интересует, где мне следует применить свои XML-комментарии. Должен ли я добавить более общий XML-комментарий в интерфейс и более описательный в реализующий класс? Например:

public interface IObjectRepository
{
    /// 
    ///    Returns an object from the respository that contains the specified ID.
    /// 
    Object GetObject(int Id);
}

public ObjectRepository : IObjectRepository
{
    /// 
    ///    Retrieves an object from the database that contains the specified ID.
    /// 
    public Object GetObject(int Id)
    {
        Object myData = // Get from DB code.
        return myData;
    }
}

Я не включил для простоты.

Это хорошая практика для комментариев или есть другой способ? Я просто пропускаю комментирование интерфейса?

Следует ли писать XML-комментарии для интерфейсов, конкретных реализаций или того и другого? [закрыто]

0 ответов

Похожие вопросы: