Учебник по программированию/Как хорошо комментировать?: различия между версиями

Материал из Викиучебника — открытых книг для открытого мира
Содержимое удалено Содержимое добавлено
Нет описания правки
Метка: possible spambot (testing)
Строка 4: Строка 4:
== <span style="color:dodgerblue">'''Как хорошо комментировать'''</span> ==
== <span style="color:dodgerblue">'''Как хорошо комментировать'''</span> ==
=== <span style="color:green">'''Комментарии в программах'''</span> ===
=== <span style="color:green">'''Комментарии в программах'''</span> ===
Начнем. У многих я думаю возникал вопрос: "Как хорошо и понятно для себя и для других комментировать?". Тут мы и поговорим. Дадим ответ на этот вопрос.
Начнем. У многих я думаю возникал вопрос: "Как хорошо и понятно для себя и для других комментировать?". Тут мы и поговорим. Дадим ответ на этот вопрос. Прежде всего начнем с неудачных комментариев в коде сайта. Вот ошибка пользователя:
<!--Сайт имеет синий фон. Две формы для авторизации пользователей. Три картинки.-->

код сайта
В чем же тут ошибка. На первый взгляд ее нет. Но тут ошибка не в синтаксисе, а в логике написания комментариев. Но что жет тут не так? Посмотрите. Сначала идет описание сайта, а уже потом '''без комментариев''' идет код сайта. Да, это неудобно из-за того, что пользователь не понимающий в HTML не поймет этот код, хотя сайт был описан перед самим кодом.
[[Категория:Учебник по программированию]]
[[Категория:Учебник по программированию]]

Версия от 05:34, 21 апреля 2014

Это пособие для начинающих. Просьба вносить предложения на странице обсуждения. Автор глобального проекта "Учебник по программированию" Волобуев Илья Евгеньевич.

Посмотреть другие учебники этого автора

Как хорошо комментировать

Комментарии в программах

Начнем. У многих я думаю возникал вопрос: "Как хорошо и понятно для себя и для других комментировать?". Тут мы и поговорим. Дадим ответ на этот вопрос. Прежде всего начнем с неудачных комментариев в коде сайта. Вот ошибка пользователя:

код сайта

В чем же тут ошибка. На первый взгляд ее нет. Но тут ошибка не в синтаксисе, а в логике написания комментариев. Но что жет тут не так? Посмотрите. Сначала идет описание сайта, а уже потом без комментариев идет код сайта. Да, это неудобно из-за того, что пользователь не понимающий в HTML не поймет этот код, хотя сайт был описан перед самим кодом.