You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: 1_python_basics/18_comments.md
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
### Обычные комментарии
4
4
5
-
Комментарии – способ прокомментировать код на ходу, на той же строке.
5
+
Комментарии – способ прокомментировать код на ходу, на той же строке.
6
6
7
7
price = Column(BigInteger) # рубли * 100
8
8
@@ -56,7 +56,7 @@
56
56
57
57
### Не сопровождать комментарии
58
58
59
-
Другая частая ошибка: не менять комментарии при изменении кода. В примере выше мы загружали данные из файла.
59
+
Другая частая ошибка: не менять комментарии при изменении кода. В примере выше мы загружали данные из файла.
60
60
Через месяц взялись за голову и поселили данные в базе данных. Код стал таким:
61
61
62
62
# загружаем данные из файла data.json
@@ -94,3 +94,11 @@
94
94
или `FIXME: учитывать часовой пояс`.
95
95
96
96
Прежде чем написать комментарий, попробуй поселить его в коде, указав параметр или дав подходящее название переменной.
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