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

Question

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

Answer 1

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

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

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

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

Answer 2

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

Answer 3

Используйте углубление, комментарии и конвенции кодирования (для проверки Python Pep8. )

Answer 4

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

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

Answer 5

Попробуйте прочитать свой код вслух (или, по крайней мере, в голове).

Answer 6

Посмотрите на эту книгу: Чистый код: Справочник Agile программного обеспечения мастерство. Отказ Это все о создании кода читаемого и понятного.

Answer 7

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

Answer 8

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

Answer 9

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

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

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