Следуйте стандартам
Лучшая практика 3. Следуйте установленным стандартам, а не создавайте их
Большинство организаций, выпускающих стандартное программное обеспечение, поддерживают свои стандарты кодирования. Эти стандарты были бы установлены опытными разработчиками программного обеспечения после многих лет разработки программного обеспечения. Это равносильно следованию по стопам оставшихся после себя великих людей.
Если в вашей организации нет стандарта, я бы посоветовал поискать в Интернете стандарты кодирования для разных языков программирования, и вы найдете их много. Стандарт кодирования фиксирует правила о различных важных атрибутах кода, некоторые из них перечислены ниже:
- Соглашение об именах файлов
- Соглашение об именах функций и модулей
- Соглашение об именах переменных
- История, отступы, комментарии
- Рекомендации по удобочитаемости
- Список того, что можно и что нельзя делать
Но после определения начните следовать определенному стандарту вместо того, чтобы создавать или изменять их каждый день. Однозначно скажу:
Исходный код - ваш РЕБЕНОК!
Так что держите его чистым, последовательным и красивым. Когда я говорю «красиво», это действительно значит «красиво». Если ваш код выглядит красиво, то другим будет легко его прочитать и понять. Если вы будете постоянно менять правила кодирования каждый день, то через несколько дней вы сами не сможете читать и понимать написанный вами код.