Давайте поймем, какую важную роль в программировании играют комментарии!

Итак, мы видели, как люди часто предлагают комментировать во время кодирования. Давайте вместе узнаем, что это за комментарии и чем они действительно полезны.

«Комментарии» - это текст, который добавляется в компьютерные программы для лучшего понимания логики реализации.

Говоря техническим языком, «комментарий - это понятное программисту объяснение или аннотация в исходном коде компьютерной программы». (источник: вики)

Есть фаза, когда каждый думает: «Когда я написал код, я смог его лучше понять !! так зачем комментировать? «

Or

«Кому помогают комментарии в моей программе? «

Или быть проще

«Какая польза от написания комментариев? «

Я сейчас отвечу на все эти вопросы…! :)

Например, вы разместили свой код на платформе с открытым исходным кодом, и пользователи пытаются его прочитать. Что, если они не справятся с потоком?

Когда мы пишем небольшие программы, это нормально, чтобы понять код и логику, приложив немного усилий. Но когда мы пытаемся создать более крупные приложения, в которых один файл связан с другим или данные отображаются из других файлов, комментарии могут помочь вам лучше понять общий вид работы кода.

Два важных сценария, в которых помогают комментарии:

1. Люди, которые ссылаются на ваш код, могут легко пройти через поток, поскольку комментарии предотвращают одну борьбу с логикой.

2. Вы сможете понять свой код, прочитав его спустя годы (такое случается с большинством программистов).

Как должны быть комментарии?

- Постарайтесь, чтобы они были актуальными.

- Не пишите больших комментариев, делайте их краткими и простыми.

- Не используйте везде. (Найдите самые сложные строки кода для комментариев).

Например, мы комментируем HTML-файл,

  • Комментарий должен быть таким, чтобы он содержал описание (одна строка) о теге и любых идентификаторах или классах, включенных в него.

Поэтому постарайтесь прокомментировать свой код, чтобы он помог вам в будущем, а также тем, кто желает сослаться на ваш код.

Я надеюсь, это поможет вам.

пожалуйста, похлопайте, если вам это понравилось, и не стесняйтесь оставлять свои отзывы. :)

Спасибо вам, ребята. !