Skip to content
Набор рекомендаций по написанию кода на C# 3.0, C# 4.0 и C# 5.0, принципов проектирования и правил оформления для улучшения общего качества вашего кода.
Branch: master
Clone or download
Pull request Compare This branch is 6 commits ahead, 92 commits behind dennisdoomen:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Build
Lib
Resources
Src
_layouts
images
.gitattributes
.gitignore
Build.bat
CNAME
Gemfile
LICENSE.md
README.md
ReSharper 9 Code Style.DotSettings
_config.yml
index.html

README.md

Рекомендации по написанию кода на C# 5.0, 6.0 и 7.0

Join the chat at https://gitter.im/dennisdoomen/csharpguidelines Build status

От переводчика

Этот документ представляет из себя перевод Coding Guidelines for C# 5.0, 6.0 и 7.0 от Aviva Solutions.

Что это

Целью создания этого списка правил является попытка установить стандарты написания кода на C#, которые были бы удобными и практичными одновременно. Само собой, мы практикуем то, что создали. Эти правила являются одним из тех стандартов, которые лежат в основе нашей ежедневной работы в Aviva Solutions. Не все эти правила имеют четкое обоснование. Некоторые из них просто приняты у нас в качестве стандартов. В конце-концов, не столько важен сам выбор, а важно то, как строго вы следуйте выбранным правилам.

Зачем мне это использовать?

Некоторые воспринимают стандарты написания кода как некие ограничения, которые ущемляют свободу творчества. Но тем не менее такой подход оправдан и проверен в течение многих лет. Почему? Потому, что не каждый разработчик знает, что:

  • на то, чтобы разобраться в коде уходит в 10 раз больше времени, чем на то, чтобы его изменить;
  • не каждый разработчик знает о тонкостях использования основных конструкций в C#;
  • не каждый знает о том, каких соглашений .NET Framework следует придерживаться, например, при использовании IDisposable или LINQ с его отложенным исполнением;
  • не каждый знает, как частные решения какой-либо задачи могут повлиять на производительность, безопасность, поддержку нескольких языков и т.д.;
  • не каждый разработчик сможет понять красивый, но абстрактный код другого разработчика;

Где я могу их получить?

На странице Releases вы сможете найти самую свежую версию данных стандартов в форматах HTML, PDF а также некоторые дополнительные файлы.

Могу ли я создать свою собственную версию?

Конечно. Лицензионное соглашение license позволяет вам копировать, адаптировать и распространять модифицированную версию этих рекомендаций в пределах вашей организации при условии указания ссылки на оригинальную версию. Это условие не является обязательным, но я буду очень благодарен, если вы укажете ссылку на меня как на автора. Я буду очень рад, если у вас есть какие-либо замечательные идеи, рекомендации, замечания или, что еще лучше, вы хотите сделать pull request. Запустите следующую команду из командной строки чтобы собрать Markdown версию данных рекомендаций.

build.bat

Есть ли поддержка со стороны анализатов кода?

Анализатор кода который поддерживает более 40 правил из данных рекомендаций доступен по ссылке https://github.com/bkoelman/CSharpGuidelinesAnalyzer. Этот инструмент с открытым исходным кодом может быть запущен во время сборки на CI сервере или во время работы в Visual Studio 2015/2017. Также добавлен обновленный файл настроек для Resharper.

You can’t perform that action at this time.