Учебник по программированию/Как хорошо комментировать?: различия между версиями
Метка: possible spambot (testing) |
Метка: possible spambot (testing) |
||
Строка 2: | Строка 2: | ||
[[Участник:Волобуев Илья Евгеньевич/Созданные учебники|Посмотреть другие учебники этого автора]] |
[[Участник:Волобуев Илья Евгеньевич/Созданные учебники|Посмотреть другие учебники этого автора]] |
||
== <span style="color:dodgerblue">''' |
== <span style="color:dodgerblue">'''Советы и ошибки в оформлении комментариях.'''</span> == |
||
=== <span style="color:green">'''Комментарии в программах'''</span> === |
=== <span style="color:green">'''Комментарии в программах'''</span> === |
||
Начнем. У многих я думаю возникал вопрос: "Как хорошо и понятно для себя и для других комментировать?". Тут мы и поговорим. Дадим ответ на этот вопрос. Прежде всего начнем с неудачных комментариев в коде сайта. Вот ошибка пользователя: |
Начнем. У многих я думаю возникал вопрос: "Как хорошо и понятно для себя и для других комментировать?". Тут мы и поговорим. Дадим ответ на этот вопрос. Прежде всего начнем с неудачных комментариев в коде сайта. Вот ошибка пользователя: |
||
Строка 13: | Строка 13: | ||
Хотя так делать правильно, но есть и нюансы по добавлению комментариев в конец строк. |
Хотя так делать правильно, но есть и нюансы по добавлению комментариев в конец строк. |
||
=== <span style="color:green">'''Нюансы комментирования'''</span> === |
=== <span style="color:green">'''Нюансы комментирования'''</span> === |
||
== <span style="color:dodgerblue">'''Два типа комментариев'''</span> == |
|||
=== <span style="color:green">'''Однострочные'''</span> === |
|||
=== <span style="color:green">'''Многострочные'''</span> === |
|||
=== <span style="color:green">'''Сравнение двух типов комментариев.'''</span> === |
|||
[[Категория:Учебник по программированию]] |
[[Категория:Учебник по программированию]] |
Версия от 05:46, 21 апреля 2014
Это пособие для начинающих. Просьба вносить предложения на странице обсуждения. Автор глобального проекта "Учебник по программированию" Волобуев Илья Евгеньевич.
Посмотреть другие учебники этого автора
Советы и ошибки в оформлении комментариях.
Комментарии в программах
Начнем. У многих я думаю возникал вопрос: "Как хорошо и понятно для себя и для других комментировать?". Тут мы и поговорим. Дадим ответ на этот вопрос. Прежде всего начнем с неудачных комментариев в коде сайта. Вот ошибка пользователя:
<!--Сайт имеет синий фон. Две формы для авторизации пользователей. Три картинки.--> код сайта
В чем же тут ошибка. На первый взгляд ее нет. Но тут ошибка не в синтаксисе, а в логике написания комментариев. Но что жет тут не так? Посмотрите. Сначала идет описание сайта, а уже потом без комментариев идет код сайта. Да, это неудобно из-за того, что пользователь не понимающий в HTML не поймет этот код, хотя сайт был описан перед самим кодом.
Добавлять комментарии правильнее в конце каждой строки. То есть так:
код сайта <!--</nowiki<комментарий<nowiki>-->
Хотя так делать правильно, но есть и нюансы по добавлению комментариев в конец строк.