Стиль кодирования: Как улучшить стили кодирования и стандарты в компании

Question

Стиль кодирования: Как улучшить стили кодирования и стандарты в компании

Существует __debug__, который является специальным значением, которое действительно предварительно обрабатывает компилятор.

if __debug__:
  print "If this prints, you're not running python -O."
else:
  print "If this prints, you are running python -O!"

__debug__ будет заменен постоянным 0 или 1 компилятором, и оптимизатор удалит любой if 0: строки, прежде чем Ваш источник будет интерпретирован.

13

coding-style

задан Seb Nilsson 22 September 2009 в 16:06

7 ответов

У стиля кодирования есть две основные стороны:

«Куда поставить открывающую скобку?» проблемы с типами - обычно они не важны, т.е. нет реальных причин предпочитать один стиль другому.
Фактические правила кодирования, например, мы используем return в середине функции.

Как я это вижу, по вопросам типа №1 нет смысла спорить. Просто установите стандарт в стандарте и обеспечьте его соблюдение (подробнее об этом позже).

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

Что касается того, как обеспечить соблюдение, документы стандартов хороши, но, по моему опыту, их просто никогда не читают и не соблюдают близко, и вскоре о них забывают. Лучший способ - это иметь какой-то автоматизированный инструмент, который сообщит вам, что вы нарушаете стандарт.

Например, даже будучи совершенно новым программистом на Java, я знал, когда использовать верхний / нижний регистр. идентификаторы просто потому, что Eclipse позволил мне (тихо, ненавязчиво) узнать, что это за стандарт.

4