Поскольку название метода модульного тестирования делает его назначение более значимым, необходимо ли добавлять сводку к методу модульного тестирования?
Пример:
/// <summary>
/// Check the FormatException should be thrown when a give country data line contains a invalid number.
/// </summary>
[TestMethod]
public void FormatException_Should_Thrown_When_Parse_CountryLine_Containing_InvalidNumber()
{
...
}
Я думаю, что длинное описательное имя важнее, чем XML-комментарий. Поскольку модульный тест не будет частью API, вам не нужен комментарий XML.
Например:
[TestMethod]
public void FormatException_Should_Thrown_When_Parse_CountryLine_Containing_InvalidNumber()
{
...
}
более полезен, чем:
///<summary>
/// Exception Should Thrown When Parse CountryLine Containing InvalidNumber
///</summary>
[TestMethod]
public void Test42()
{
...
}
XML-комментарии следует использовать для документирования API и фреймворков.
На самом деле я предпочитаю использовать DescriptionAttribute вместо сводного тега. Причина в том, что значение атрибута Description будет отображаться в файле результатов. Это упрощает понимание сбоев, когда вы просто смотрите на файл журнала.
[TestMethod,Description("Ensure feature X doesn't regress Y")]
public void TestFeatureX42() {
..
}
Description? Я знаю, что этот пост устарел, но я никогда не знал, что для тестов существует отдельный атрибут описания, и сразу же добавил его, чтобы посмотреть, как он выглядит. К моему удивлению, я нигде его не видел. Была ли функция удалена (в таком случае, не будет ли атрибут объявлен устаревшим?) или я что-то упустил?
- person julealgon; 20.08.2014
Лично я стараюсь сделать тесты достаточно простыми, чтобы документация была избыточной. Я использую встроенные комментарии в тестовом методе, чтобы объяснить почему я делаю что-то определенным образом, а не что я делаю.
Необходимо добавить сводку, когда сводка может предоставить больше информации, которая может/должна быть закодирована в имени метода. Обратите внимание, что когда я говорю «необходимо», имея в виду какую-либо документацию, я имею в виду «необходимо передать 100% необходимого контекста/деталей/нюансов новому кодеру, унаследовавшему проект, или вам самому через 5 лет».
Не обязательно, но если вы чувствуете, что комментарии XML добавляют ценность помимо названия самого модульного теста (которое выглядит всеобъемлющим), то вы окажете услугу другим разработчикам.
Если сводка по сути является прямым дубликатом имени метода модульного тестирования, то я думаю, что это излишество.
В приведенном выше примере я бы сказал, что в этом нет необходимости, если вы не используете инструмент, который извлекает документацию из исходного кода (например, javadoc или что-то в этом роде).
Общее эмпирическое правило заключается в том, что в коде говорится, что вы делаете, а в комментарии объясняется, почему, но, поскольку имя очень подробное (что, я думаю, нормально, поскольку никто никогда не должен его набирать), я не думаю, что комментарий способствует чему-либо.
Комментарий XML совершенно не нужен, если у вас есть описательное имя метода. И это обязательно для методов модульного тестирования.
Вы уже на правильном пути, имея описательное название метода тестирования. (Многие практики agile и TDD считают, что метод тестирования должен включать «следует», например, как показано в текст ссылки на этот пост в блоге.
Лично мне нравятся такие имена методов:
MyClass_OnInvalidInput_ShouldThrowFormatException()
Но это всего лишь мои личные предпочтения.
Если вы думаете, что это лучшее использование вашего времени, сделайте это, в противном случае не делайте этого. я бы не стал.
