Как писать комментарии к параметрам метода?
В каком виде следует писать комментарии к параметрам метода, чтобы при вызове метода в его подсказке были эти комментарии?
Источник: Stack Overflow на русском
Ответы
Есть такая штука - xml-комментарии. Они отличаются от обычных тем, что предваряются тремя слэшами, а не двумя. Например:
/// <summary>
/// Описание метода
/// </summary>
/// <param name="arg">Описание параметра</param>
/// <returns>Ogbcfybt возвращаемого значения</returns>
public int SomeMethod(string arg)
Ставите /// слеша перед именем члена, далее студия сгенерирует вам заглушку для комментариев. Заполнить ее можно как в примере.
/// <summary>
/// Некоторый метод.
/// </summary>
/// <param name="count">Количество</param>
/// <returns></returns>
public void Method(int count)
{
}