Формат комментирования C # с NUnit и комментированием XML - PullRequest
3 голосов
/ 02 сентября 2011

При написании кода C # с использованием NUnit и комментирования XML существует ли обязательный или предпочтительный формат, для которого на первом месте?

Будет ли:

using NUnit.Framework;


namespace FooBar{

    /// <summary> 
    /// The <c>foo</c> class tests bar
    /// </summary>
    [TestFixture]
    public class Foo{
    }
}

правильным или будет:

using NUnit.Framework;


namespace FooBar{

    [TestFixture]
    /// <summary> 
    /// The <c>foo</c> class tests bar
    /// </summary>
    public class Foo{
    }
}

быть лучше?

1 Ответ

7 голосов
/ 02 сентября 2011

Это не относится только к NUnit - это любые атрибуты.

Это вопрос предпочтений, но, по крайней мере, для меня комментарии должны предшествовать коду - атрибуты тоже считаются кодом.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...