Каковы стандарты "форматирования" C#?

в C#(.NET), каковы обычные стандарты "форматирования"?

например, для имен параметров, до сих пор я заметил camelCase без префикса, верно? Для имен объектов, camelCase и без префикса, верно?

для пространств имен, классов, функций и свойств первая буква слова заглавная и нет префикса, это правильно (снова)?

как "временные" объекты отформатирован?

пример:

namespace TestNamespace
{
    class MyOwnCoolClass
    {
        MyOwnCoolClass(int length, BinaryWriter writer)
        {
            BinaryWriter tempbw = new BinaryWriter(length);
            return tempbw;
        }
    }
}

(Примечание: этот код недействителен, я знаю, это просто для демонстрации форматирования). Спасибо!

6
.net c# formatting standards

7 ответов

Если вы используете StyleCop, вы получите хорошую согласованность с рекомендации по разработке Microsoft .NET для разработки библиотек классов. StyleCop также обеспечивает несколько дополнительных вещей, таких как интервал, порядок элементов в файле и именование элементов непубличного кода.

13

полные рекомендации от Microsoft можно найти в Руководство По Дизайну Класса. Он старый, но я еще не нашел ничего обновленного на MSDN, и я считаю, что это все еще стандартный набор рекомендаций

5

Я писал эти директивы над прошлым годом используя различные директивы от MSFT и других широко принятых директив. Вы можете проверить это, у него есть и другие вещи, такие как настройка проектов и тому подобное, но все рекомендации по именованию также есть.

edit: Я заметил, что это старая версия, у меня есть новая версия, которую я писал некоторое время, и он содержит много полезностей, но это не сделано. Я буду обновлять это сообщение, когда оно опубликовано.

2

Я бы посмотрел на следующее Практики Кодирования.

Он охватывает практически все, что я вижу в большинстве кода C#, который я читаю...включая префиксные элементы пользовательского интерфейса. Я лично не следую этому письму, но это дает вам хорошее представление об общем стандарте и о том, что такое хорошая/плохая практика.

0

есть ссылки на стандарты кодирования от Microsoft. Visual Studio 2005 и 2008 имеют встроенный механизм анализа кода, который проведет вас через эти стандарты кодирования, а также укажет вам на некоторые рекомендации. Щелкните правой кнопкой мыши на своем проекте и нажмите "Запустить анализ кода в проекте".

всякий раз, когда обнаруживается недопустимая или менее предпочтительная часть кода, она не только предупреждает вас, но и указывает на ресурс справки на сайте FxCop.

0

MSDN:Указания По Именованию

Я склонен следить за тем, как кодируется .NET framework, чтобы мой код соответствовал .NET Framework.

мое единственное личное предпочтение-это именование переменных класса, которые я использую префикс " m_ " перед каждой переменной, такой как private int m_count.

0

вы можете использовать комбинацию StyleCop и FxCop (или встроенный анализ кода для VS2008 Pro) для инструментов и Основные Принципы Проектирования.

0