Содержание

• Шаги
• Вопросы и ответы сообщества
• подсказки

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

Шаги

1. 

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

2. 

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

3. 

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

4. 

   
   
   Ссылка на стандарт кодирования в заголовке файла. Если возможно, предоставьте файл, который инструменты могут открыть для включения правильных настроек. Например, Eclipse по умолчанию использует вкладки, но вкладки отображаются по-разному в разных текстовых редакторах. Использование пробелов вместо вкладок может быть предпочтительнее, но наличие файла, обеспечивающего правильные настройки для проекта.

5. 

   Используйте пустое пространство. Пропускайте строки между кодом, который выполняет разные действия, и используйте пробелы после точек с запятой и запятых. Это сделает ваш код более чистым и легким для чтения.

6. 

   Сделайте отступ внутри фигурных скобок. Таким образом становится очевидным, что один фрагмент кода отделен от другого. Это может помочь при написании длинного метода. Отступы внутри операторов if и циклов упростят чтение. Этот метод называется вложением, то есть он показывает, что кусок кода «вложен» в другой фрагмент кода, и позволяет читателю легко следовать шаблону вложенности.

7. 

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

8. 

   Сделайте свой код «самодокументированным», создав описательные имена объектов, которые описывают их цели. Объекты должны ссылаться либо на область проблемы, либо на стандартные программные артефакты. Список - это список. Возможно, вам придется создать список клиентов, который подклассы или реализует список. Переменные и параметры функций должны иметь описательные имена.

9. 

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

10. 

    Часто комментируйте. Напишите комментарии, чтобы указать на свое намерение. Излишнее комментирование кода приведет к тому, что кто-то удалит ваши комментарии.

Вопросы и ответы сообщества

подсказки

• Упрощение чтения кода также поможет вам отлаживать собственную программу, облегчая вашу жизнь.
• Постоянные переменные следует указывать заглавными буквами, а слова разделять знаком подчеркивания. В обычных переменных первые буквы каждого слова должны быть заглавными, без подчеркивания.
• Добавьте пробелы, если они разрешены.
• Если вы хотите прокомментировать большой кусок текста, используйте «/ *», чтобы начать комментарий, и « * /», чтобы закончить его. Тогда вам не нужно писать «//» в каждой строке. (Обратите внимание, что комментарии могут отличаться на других языках)
• Найдите свой стиль написания кода. Вы можете использовать множество стилей, например следующие примеры: myVariable, MyVariable, myvariable, MYVARIABLE, My_Variable, MY_VARIABLE, my_variable, my_Variable, My_variable и другие. Убедитесь, что вы присвоили каждому стилю определенный тип, например MY_VARIABLE для постоянных переменных и myVariable для обычных переменных. Просто убедитесь, что вы придерживаетесь стиля. Вы же не хотите, чтобы у вас были постоянные переменные myVariable и MY_VARIABLE.