Страницы

Поиск по вопросам

среда, 18 декабря 2019 г.

Как писать комментарии к параметрам метода?

#c_sharp #документация #комментарии


В каком виде следует писать комментарии к параметрам метода, чтобы при вызове метода
в его подсказке были эти комментарии?
    


Ответы

Ответ 1



Есть такая штука - xml-комментарии. Они отличаются от обычных тем, что предваряются тремя слэшами, а не двумя. Например: /// /// Описание метода /// /// Описание параметра /// Ogbcfybt возвращаемого значения public int SomeMethod(string arg)

Ответ 2



Ставите /// слеша перед именем члена, далее студия сгенерирует вам заглушку для комментариев. Заполнить ее можно как в примере. /// /// Некоторый метод. /// /// Количество /// public void Method(int count) { }

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

Отправить комментарий