none
Добавление описания методов. Документирование. RRS feed

  • Вопрос

  • Есть вопрос. Он наверно к документированию относится больше. 
    Когда мы создаём экземпляр класса, мы можем использовать методы его интерфейса.
    Чтобы использовать методы,мы ставим точку. Далее студия выдаёт список методов. И ещё иногда под методами содержится описание того,что делает метод и список параметров с пояснениями. Ну это обычно присуще более менее стандартным объектам.

    Вот хотел узнать,если ли возможность мне для своего собственного класса добавить подобное описание? Чтобы оно всплывало по такой же схеме. 

    Надеюсь,понятно объяснил,чего хочу)

Ответы

  • Над методом, классом, свойством, чем-угодно, пишите 3 слеша ///

    В итоге получится что-то вроде такого:

    /// <summary>
           /// Method do something
           /// </summary>
           /// <returns>returns super important value</returns>
           /// < Поставьте угловую скобку и Вам предложит список
            public int SomeMethod()
            {
                return 0;
            }

    • Предложено в качестве ответа LXGDARK 3 июля 2014 г. 5:49
    • Помечено в качестве ответа mpnj 7 июля 2014 г. 9:50
  • Если написать xml-комментарии, то подсказки появятся в текущем проекте.

    Если вы пишете библиотеку, которая будет использоваться в других проектах, то нужно в свойствах проекта на вкладке Build поставить галочку XML documentation file - и сгенерированный файл поставлять вместе с dll.

    • Предложено в качестве ответа Oleg Kurzov 5 июля 2014 г. 7:08
    • Помечено в качестве ответа mpnj 7 июля 2014 г. 9:50
    4 июля 2014 г. 15:34
  • Добрый день, конечно можно.

    В строке над именем класса (метода, свойства) нажимаете 3 раза на "/" и получаете заготовку:

    /// <summary>
    /// Делать то-то
    /// </summary>
    /// <remarks>Примечание и т.д.</remarks>

    Все - комментируйте код.

    Так же можно генерировать документацию в Sandcastle Help Builder или аналогичных программах.

    Почитать: XML документация

    • Изменено Maxim Shusharin 3 июля 2014 г. 6:11
    • Помечено в качестве ответа mpnj 7 июля 2014 г. 9:50

Все ответы

  • Над методом, классом, свойством, чем-угодно, пишите 3 слеша ///

    В итоге получится что-то вроде такого:

    /// <summary>
           /// Method do something
           /// </summary>
           /// <returns>returns super important value</returns>
           /// < Поставьте угловую скобку и Вам предложит список
            public int SomeMethod()
            {
                return 0;
            }

    • Предложено в качестве ответа LXGDARK 3 июля 2014 г. 5:49
    • Помечено в качестве ответа mpnj 7 июля 2014 г. 9:50
  • Добрый день, конечно можно.

    В строке над именем класса (метода, свойства) нажимаете 3 раза на "/" и получаете заготовку:

    /// <summary>
    /// Делать то-то
    /// </summary>
    /// <remarks>Примечание и т.д.</remarks>

    Все - комментируйте код.

    Так же можно генерировать документацию в Sandcastle Help Builder или аналогичных программах.

    Почитать: XML документация

    • Изменено Maxim Shusharin 3 июля 2014 г. 6:11
    • Помечено в качестве ответа mpnj 7 июля 2014 г. 9:50
  • Если написать xml-комментарии, то подсказки появятся в текущем проекте.

    Если вы пишете библиотеку, которая будет использоваться в других проектах, то нужно в свойствах проекта на вкладке Build поставить галочку XML documentation file - и сгенерированный файл поставлять вместе с dll.

    • Предложено в качестве ответа Oleg Kurzov 5 июля 2014 г. 7:08
    • Помечено в качестве ответа mpnj 7 июля 2014 г. 9:50
    4 июля 2014 г. 15:34
  • Всем спасибо за информацию.