Блог

#c# #.net #visual-studio #visual-studio-2010 #xml-documentation

#c# #.net #visual-studio #visual-studio-2010 #xml-документация

Вопрос:

 ///<summary>
///This is summary for some class or method
///</summary>
 

 ///<doc>
///always use this list!
List<String> beer = new List<String>();
 

 public class BeerForall
{
    /// <summary>
    /// it works here
    /// </summary>
    public List<String> beer = new List<string>();

    public String giveBeer()
    {
        /// is not working, u can not comment
        /// <summary>
        /// test test, not working
        /// </summary>
        List<String> moreBeer = new List<string>();

        return "beer";
    }
}
 

Комментарии:

1. Он отлично работает для всех свойств и полей, но, вероятно, не будет работать ни для одной переменной в функции?

2. черт, вы правы:/ не работает в методе. В классе вы можете документировать как обычно, но внутри метода / функции это не работает! Есть способ заставить это работать?

3. Да, это действительно работает для методов? Где определен ваш метод и откуда вы его вызываете? Если это отображается в intellisense, будут показаны комментарии. Иногда загрузка может занять всего несколько секунд.

4. Вы не можете документировать локальные переменные.

5. Упс. Не видел внутри метода, нет, это не работает.

Ответ №1:

Комментарии:

1. Возможно, вы не понимаете, как это может быть полезно. Я предлагаю вам взглянуть на doxygen. В doxygen любую документацию, которую вы можете написать в комментарии перед функцией, вы можете написать и внутри функции. Это позволяет вам продолжить, например, раздел комментариев с объяснением алгоритма, чередованием кода и документации в стиле, который очень близок к буквальному программированию. Некоторые фрагменты кода приносят большую пользу.

2. Рефакторинг кода хорош, но я не понимаю, как изъятие инструментов у программиста является полезной «функцией» для обеспечения соблюдения надлежащих методов кодирования. Черт возьми, я не думаю, что это работает, тот, кто написал кодовую базу, которую я поддерживаю сейчас, не сказал «о, боже, я не могу комментировать локальные переменные, так что это означает, что теперь я буду кодировать лучше». Кроме того, гипотетически, если это действительно было упущено для поощрения хорошего стиля кодирования, почему комментарии локальной переменной Intellisense работают для C / C , но не для C # в VS2013?

3. «Я не думаю, что эта функция должна существовать, поскольку она будет служить только для облегчения написания чрезмерно больших функций». Я думаю, что это должно существовать, если вы не можете переписать более 30 тыс. строк кода серверной части, с которой мне приходится иметь дело.

4. На самом деле мы документируем эти переменные, чтобы в первую очередь реорганизовать мега-методы, и отсутствие этой функции не помогает…

Ответ №2:

Комментарии:

1. в самом классе это работает. но попробуйте что-то документировать в методе. смотрите мой отредактированный первый пост

2. Да, это то, что я сказал в своем первом комментарии к вашему вопросу, вы не можете документировать переменные, определенные в самом методе.

3. было бы здорово, если бы это работало для локальных переменных уровня метода.. просто чтобы у вас был intellisense для вашего локального кода. Я имею в виду, почему бы и нет?

Ответ №3:

Ответ №4:

Ответ №5:

Ответ №6:

Комментарии:

1. К сожалению, связанная документация применима только к Javascript. Я пробовал использовать <var> локальную переменную как таковую, никакого эффекта.