Как понять, что вы написали хороший код?
Вы написали код, но задаетесь вопросом о его качестве? Наша очередная статья - подборка ответов о том, как определить качество написанного кода.
Мы собрали для вас лучшие советы пользователей stackexchange, которые помогут вам в этом вопросе.
1. Методы короткие и в идеале выполняют одно задание.
2. Для вызова функций вам не нужно подсматривать в них.
3. Писать юнит тесты - просто.
4. Вам легко возвращаться к работе над кодом после некоторого промежутка времени.
5. Названия классов, переменных и функций хорошо продуманы и имеют смысл, не заставляют думать слишком много.
6. Изменять и дополнять существующий код, не ломая его логики – легко.
7. Все написано с умом, но не слишком.
8. Изменяя один метод, вам не нужно менять другие.
9. Прочитав код, легко понять базовую логику, алгоритмы, вводы и выводы.
10. Ваш коллега при прочтении кода хорошо понимает, что делает та или иная его часть.
11. Другие разработчики могут легко изменять оригинал, исправлять баги, заниматься рефакторингом.
Тест на качество кода:
Вы показываете свой труд другому программисту, а сами садитесь рядом. Читая код, ваш коллега должен объяснить, что делает тот или иной модуль. Чем больше у вас желание поправить его, либо возразить, тем хуже качество кода. И напротив, если вы сидите тихо и спокойно, то вероятно код хороший.
Хороший код – понятный код. Помните, что вы пишите не только для машины, но и для людей. Поэтому чтобы облегчить жизнь себе и своим коллегам старайтесь писать его просто и изящно, не загромождайте его чересчур сложными конструкциями. Все, что может быть простым - должно быть простым. Советы, приведенные выше - лишь небольшая часть от огромного количества руководств по написанию, но даже их достаточно для того, чтобы определить каким является ваш код. Но не останавливайтесь на достигнутом, увеличивайте запас знаний и больше практикуйтесь, и, возможно, однажды, вопросы о качестве написанного не будут вас больше мучить.
Советуем также прочитать:
Что должен знать каждый программист?
8 советов для быстрого понимания чужого кода
Как превратить программирование в профессиональное ремесло