Семантика метода – это описание того, что данный метод делает. Семантика метода включает в себя описание того, что является результатом вычисления метода, как и от чего этот результат зависит. Обычно результат выполнения зависит от значений аргументов метода. К понятию семантики можно отнести как тело метода и возвращаемое значение, так и out аргументы.
Пример написания описания к методу Add:
/// <summary>
/// Сложение двух целых чисел.
/// </summary>
/// <param name="summand1">Первое слагаемое</param>
/// <param name="summand2">Второе слагаемое</param>
/// <returns>Сумма</returns>
static int Add(int summand1, int summand2)
{
return summand1 + summand2;
}
Если посмотреть на использование метода Add в Visual Studio, то будет следующее:
Без описанием метода :
С описанием метода :
Зачастую методам дописывают описание, что бы программисты, использующие эти методы, могли прочитать: что они делаю, что принимают и что возвращают, а не искать данные методы в коде и разбираться с этим самим (тем самым тратя своё время при разработке приложения).
Источник: видеоурок Александра Шевчука "МЕТОДЫ"
предыдущая статья