Сообщение Информация для разработчиков библиотеки от 19.03.2016 13:03
Изменено 19.03.2016 13:04 AndrewVK
Make wiki
Стиль кода
Стиль кодированияКоротко (с поправками):
- Отступы — табуляция. Рекомендуется так же включать visible whitespaces и не оставлять в коде пробельный мусор.
Имена типов и публичных членов — PascalCasing
Имена приватных членов — camelCasing с префиксом '_'
Имена параметров и локальных переменных — camelCasing
Максимальная длина строк — 120 символов.
Дополнительные требования к коду
- Обязательно наличие doc comments к публичному API
Для любого нетривиального кода должны быть тесты хотя бы по основным use cases
Желательно использование решарпера и разметка кода Jetbrains.Annotations. Прежде всего это касается NotNull/CanBeNull.
Cтарайтесь максимально использовать конструкции языка, улучшающие читаемость кода: var, expression bodied members, string interpolation
Обязательно никаких warnings компилятора, и очень желательно никаких warnings решарпера. Если у вас нет лицензии на решарпер — используйте хотя бы бесплатные Resharper Command Line Tools.
В Main проект помещайте только тот код, в полезности которого вы абсолютно уверены.
... << RSDN@Home 1.0.0 alpha 5 rev. 0 on Windows 8 6.2.9200.0>>
Информация для разработчиков библиотеки
Стиль кода
Стиль кодированияКоротко (с поправками):
- Отступы — табуляция. Рекомендуется так же включать visible whitespaces и не оставлять в коде пробельный мусор.
Имена типов и публичных членов — PascalCasing
Имена приватных членов — camelCasing с префиксом '_'
Имена параметров и локальных переменных — camelCasing
Максимальная длина строк — 120 символов.
Дополнительные требования к коду
- Обязательно наличие doc comments к публичному API
Для любого нетривиального кода должны быть тесты хотя бы по основным use cases
Желательно использование решарпера и разметка кода Jetbrains.Annotations. Прежде всего это касается NotNull/CanBeNull.
Cтарайтесь максимально использовать конструкции языка, улучшающие читаемость кода: var, expression bodied members, string interpolation
Обязательно никаких warnings компилятора, и очень желательно никаких warnings решарпера. Если у вас нет лицензии на решарпер — используйте хотя бы бесплатные Resharper Command Line Tools.
В Main проект помещайте только тот код, в полезности которого вы абсолютно уверены.