Существуют ли какие-либо основные стандарты и практики для создания удобочитаемого кода?

Question

Более конкретно, сделать HTML, Java и Python более читабельным? У кого-нибудь есть предложения для этого студента по программированию?

Answer 1

Использовать отступы, комментарии и соглашения о кодировании (для проверки Python PEP8 )

Answer 2

1. Используйте согласованные регистр и имена.

2. Используйте вкладки (и скобки, где они доступны), чтобы обеспечить визуальный поток.

3. Используйте комментарии, которые объясняют, что происходит концептуально, а также технически. (например, // У нас есть действительный пользователь? нет // Проверить, что user_ID не равен -1)

Я уверен, что у некоторых более опытных разработчиков будет больше предложений, но это мои лучшие 3.

Answer 3

Правильный отступ и информативные комментарии.

Answer 4

Убедитесь, что ваш код хорошо структурирован (правильные отступы, пустые строки для отдельных разделов кода и т. Д.) И используйте стандартные, согласованные и полностью именованные (а не непонятные сокращенные) имена переменных.

Другиепредложил бы использовать правильные комментарии.Я бы не согласился.Если ваш код хорошо структурирован и переменные имеют правильные имена, то комментарии будут просто загромождать вещи.Исключением из этого правила является то, что вы должны сделать что-то нелогичное, чтобы обойти ошибку где-то еще (я должен был прибегнуть к этому в коде WCF и Entity Framework в прошлом).

Answer 5

Взгляните на эту книгу: Чистый код: руководство по гибкому программному мастерству .Все дело в том, чтобы сделать код читабельным и понятным.

Answer 6

Попробуйте прочитать ваш код вслух (или хотя бы в своей голове).

Answer 7

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

Answer 8

Один совет - не лениться с именами.Например, если у вас есть класс Java, который является реализацией интерфейса Transformer, и он преобразует String в Date, не стесняйтесь назвать класс StringToDateTransformerImpl.

Answer 9

Правильные отступы при написании HTML могут быть спасением, особенно когда вы взаимодействуете с любым видом вложенных элементов.Просто будьте совместимы с отступом и не забудьте обновить окружающие строки при перемещении или удалении элемента с отступом.Это значительно упрощает обновление страницы, поскольку уровень отступа даст подсказку о том, где вы находитесь на странице, не прибегая к каким-либо маневрам Ctrl + F.

Стоит также отметить, что еслиВы используете CSS в сочетании с HTML, правильное именование имеет решающее значение!Это улучшит ваш рабочий процесс и удобочитаемость вашего кода.

Я также большой поклонник отступов, пробелов и комментариев при написании "реального" (Java, Python, C и т. Д.) Кода.Я склоняюсь к (x + 1) над (x + 1), потому что лично я думаю, что это имеет большое значение в удобочитаемости.Я размечаю броски, приращения и т. Д., И они гораздо легче меня замечают.Будьте совместимы со стилем скобок / отступов и свободно комментируйте - помните, что переписывание имени метода не является комментарием!