ixSci
@ixSci

Ручная или автоматическая проверка стиля кодирования?

Доброго времени суток, коллеги, программисты!


У меня вопрос для тех, кто использует стиль кодирования(coding style) в команде: как вы проверяете соответствие? Есть специальные программы для проверки или вы проверяете всё вручную? Если проверяет программа, то как проверяются такие моменты, как несоответствие стиля кодирования в используемой библиотеки и вашего.

К примеру, в вашей команде принято писать имена методов с заглавной букву DoSomething, в вашей программе используются библиотеки(C++) boost и Qt, которые вынуждают вас переопределять поведения методов с именами do_something() и doSomething() соответственно. Получается, что программа для проверки будет иметь ложное срабатывание? Как вы с этим боритесь?


В общем вопрос не праздный, хочется проверки стиля кодирования, но я не уверен, что есть смысл тратить время на поиск подходящей программы. Т.к. я не вижу пути, как она сможет решить проблему описанную выше, равно как и проблему с неправильным именованием переменных или инвариантов(«не говорящие» имена)


Заранее спасибо за мнения!
  • Вопрос задан
  • 3051 просмотр
Решения вопроса 1
@gribozavr
Автоформаттеры/авточекеры имеют смысл только когда coding style вводится в существующий проект для уменьшения количества ручной работы на этом этапе. В практической деятельности их можно использовать только как вспомогательный инструмент, а не как жёсткий критерий принятия/отклонения коммита как минимум из-за того, что в любом нормальном coding style есть правило «вы можете нарушить любое правило если это позволяет значительно улучшить читаемость/поддерживаемость кода».
Ответ написан
Пригласить эксперта
Ответы на вопрос 2
difiso
@difiso
В параллельной вселенной я космонавт
Когда мы писали проект на Zend, то использовался phpcs (у него есть поддержка разных стандартов, среди которых и Zend). Этого хватало, а раз в месяц просто последнюю ревизию правили ручками, при правильно настроенной IDE править руками если и придется, то очень мало.
Ответ написан
@Bonart
А не проще использовать автоматический форматтер? Сразу будет проверка + приведение в божеский вид.
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы