Предложение для написания более читабельного кода?

Question

Какие у вас есть советы / предложения по написанию более понятного кода?

Я был несколько разочарован отсутствием структуры и плохим форматом некоторого кода, который я поддерживал в последнее время, и хотел бы предложить ряд рекомендаций по написанию более понятного кода.

Любое предложение может помочь, независимо от языка.

Привет.

Answer 1

Некоторые приходят на ум:

• Не стоит без необходимости ставить this перед такими методами, как:

this.doSomething();

• Не используйте венгерский язык, такой как:

private int mCount;

• Объявляйте локальные переменные близко к месту их использования, желательно как можно позже

Answer 2

Выберите стиль кодирования & mdash; любой стиль кодирования & mdash; используйте его последовательно (вместе с кем-либо в вашей команде). Если вы используете непротиворечивый стиль, вы привыкнете к нему и разработаете запах кода , который предупредит вас о плохом коде.

Существует много инструментов, которые можно использовать для автоматического форматирования кода, и если вы используете IDE, он может иметь один встроенный.

Answer 3

Кажется, вопрос действительно в том, чтобы преобразовать нечитаемый код в читаемый код, который отличается от написания нового читаемого кода.

Прежде чем делать что-либо еще:

1. Если это еще не сделано,используйте контроль версий.
2. Если это еще не сделано, используйте автоматическое тестирование.

Как правило, клиенту все равно, насколько читаем код.Заказчик очень заботится о том, будет ли программное обеспечение функционировать должным образом.

Когда вы изначально получаете нечитаемое программное обеспечение для обслуживания, у вас есть козел отпущения за ошибки программного обеспечения.Но если ваш предшественник исправил ошибку по запросу клиента и вы случайно удалили исправление (возможно, оно было очень нечитабельным), у клиента не будет большого терпения.