Коментарі надзвичайно корисні в будь-якій мові програмування. До цього часу ваші програми складалися тільки з коду Python. У міру зростання обсягу і складності коду в програми слід додавати коментарі, які описують загальний підхід до розв'язуваної задачі, - свого роду замітки, написані зрозумілою мовою.
Як створюються коментарі?
У мові Python ознакою коментаря є символ «решітки» (#). Інтерпретатор Python ігнорує всі символи, такі в коді після # до кінця рядки. Приклад:
comment.py
# Say hello to everyone.
print ("Hello Python people!")
Python ігнорує перший рядок і виконує другий
Hello Python people!
Які коментарі слід писати?
Коментарі пишуться насамперед для того, щоб пояснити, що повинен робити ваш код і як він працює. В ході роботи над проектом ви розумієте, як працюють всі його компоненти. Але, якщо повернутися до проекту через деякий час, швидше за за все, деякі подробиці будуть забуті. Звичайно, завжди можна вивчити код і розібратися в тому, як повинні працювати його частини, але хороші коментарі з доступним викладом загальних принципів роботи коду заощадять немало часу. Якщо ви хочете стати професійним програмістом або брати участь у спільній роботі з іншими програмістами, навчіться писати осмислені коментарі. У наші дні майже всі програми розробляються колективно в групах - або групами працівників однієї компанії, або групами ентузіастів, які працюють разом над проектом з відкритим кодом. Досвідчені програмісти очікують побачити коментарі в коді, тому краще звикайте додавати змістовні коментарі прямо зараз. Написання простих, лаконічних коментарів - одна з найкорисніших звичок, необхідних починаючому програмісту.
Приймаючи рішення про те, чи потрібно писати коментар чи ні, запитайте себе, чи довелося вам перебрати кілька варіантів в пошуках розумного рішення для деякої задачі; якщо відповідь буде позитивною, напишіть коментар з приводу вашого рішення. Видалити зайві коментарі пізніше набагато простіше, ніж повертатися і додавати коментарі до програми. З цього моменту я буду використовувати коментарі в прикладах для пояснення сенсу деяких частин коду.
- Войдите или зарегистрируйтесь, чтобы оставлять комментарии