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

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


== <span style="color:dodgerblue">'''Два типа комментариев'''</span> ==
== <span style="color:dodgerblue">'''Два типа комментариев'''</span> ==

Версия от 15:04, 21 апреля 2014

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

Это часть проекта "Учебник по программированию" предназначена для тех, кто читал уже тему комментарии в проекте TGP. Посмотреть другие учебники этого автора

Советы и ошибки в оформлении комментариях.

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

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

<!--Сайт имеет синий фон. Две формы для авторизации пользователей. Три картинки.-->
код сайта

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

Добавлять комментарии правильнее в конце каждой строки. То есть так:

код сайта <!--</nowiki<комментарий<nowiki>-->

Хотя так делать правильно, но есть и нюансы по добавлению комментариев в конец строк.

Нюансы комментирования

Добавлять комментарии в конец каждой строки - это удобно, но нужно знать некоторые правила по комментированию. Например не надо употреблять много научных терминов по информатике. Эти комментарии тогда просто не принесут пользы новичкам, а тем более Вам. Потому, что они не поймут и в конце концов все кончится бесконечными вопросами. Во-вторых не надо писать например на русском языке комментарии, если Вы находитесь в Англии. Это неуместно лишь по одной причине: "Никто Вас не поймет (почти никто)."

Два типа комментариев

Однострочные

Многострочные

Сравнение двух типов комментариев.