Skip to content

Commit f197ad0

Browse files
Update 18_comments.md
Лена добавила раздел Что изучать в статью про комментарии
1 parent 631b3c4 commit f197ad0

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

1_python_basics/18_comments.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Обычные комментарии
44

5-
Комментарии – способ прокомментировать код на ходу, на той же строке.
5+
Комментарии – способ прокомментировать код на ходу, на той же строке.
66

77
price = Column(BigInteger) # рубли * 100
88

@@ -56,7 +56,7 @@
5656

5757
### Не сопровождать комментарии
5858

59-
Другая частая ошибка: не менять комментарии при изменении кода. В примере выше мы загружали данные из файла.
59+
Другая частая ошибка: не менять комментарии при изменении кода. В примере выше мы загружали данные из файла.
6060
Через месяц взялись за голову и поселили данные в базе данных. Код стал таким:
6161

6262
# загружаем данные из файла data.json
@@ -94,3 +94,11 @@
9494
или `FIXME: учитывать часовой пояс`.
9595

9696
Прежде чем написать комментарий, попробуй поселить его в коде, указав параметр или дав подходящее название переменной.
97+
98+
99+
## Что изучать
100+
101+
- [Доклад Григория Петрова про комментирование исходников](https://www.youtube.com/watch?v=-SRUctRR_4s). Обязателен к просмотру.
102+
- [PEP 257](https://www.python.org/dev/peps/pep-0257/). ПЕП про докстринги.
103+
- [doctest](https://docs.python.org/3.5/library/doctest.html). Документация к модулю про доктесты.
104+
- [What is the best comment in source code you have ever encountered?](http://stackoverflow.com/questions/184618/). Шутить в коде не стоит, а вот посмеяться с чужих шуток можно. Это ж не нам поддерживать.

0 commit comments

Comments
 (0)