Новости школы:

News image

Какими должны быть взаимоотношения учеников и учителей?

Мы должны помнить, что права и обязанности есть и у преподавателей, и у учеников, что никто никому не должен, что мы нуждаемся д...

News image

Как избежать конфликтов подростка с учителями?

Самое главное в жизни ребенка, который учится – это не только взаимоотношения с одноклассниками, но и с учителями. Как реагир...

News image

Самые распространенные конфликты

Конфликт неподчинения. Подросток отказывается выполнять те или иные требования. Часто такие, которые год назад не вызывали такой...

News image

Каждый день - одно и то же!

Многие родители, приводя чадо в первый класс, сталкиваются с необходимостью приобретать школьную форму для ребенка. И, несмотря ...


Главная Новости образования Обучение HTML: хорошо ли вы комментируете ваш HTML и CSS?

Обучение HTML: хорошо ли вы комментируете ваш HTML и CSS?
Школа - Новости
21.07.2016 14:37

Насколько хорошо вы комментируете ваш HTML и CSS код

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

Работа в новой компании у каждого начинается со скучного изучения мануалов и документации. Фирмы разные, а это значит, что база кода, фреймворки, требования — отличаются.

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

Почему комментировать код важно?

Когда вы работаете в одиночку, например, будучи фрилансером или единственным разработчиком на проекте, вам достаточно самостоятельно разбираться в своем коде. И то проходит некоторое время, и вы с недоумением смотрите на свой код, мысленно спрашивая себя «О чем я тогда думал_а?», тщетно пытаясь его понять.

Комментарии могут помочь

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

Читабельные комментарии. Это очень важно в командной работе. Одно дело, когда вы пишите комментарии для себя и совсем другое дело, когда над небольшим куском программы, которую вы создали, дальше будет работать ваш коллега. Хорошо написанные комментарии помогу ему быстрее разобраться в логике, понять принятые вами решения. Как следствие поставленная задача будет выполнена в сроки и без лишней нервотрепки.

Комментарии так же могут помочь с правками. Вы можете оставлять комментарии не только о том, что написали, но и помечать куски кода, которые требуют правок. Такая практика будет очень полезна front end разработчикам.

Комментирование ускоряет процесс разработки. Благодаря этому вы лучше понимаете то, что пишите, меняете или удаляете.

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

То, что не стоит писать в комментариях

Избегайте комментирования всего подряд. Возможно, трудно отказать себе в привычке комментировать каждый блок кода. Но большое количество комментариев может раздражать. Старайтесь объяснять только те участки кода, которые явно не будут понятны, даже с хорошим и вроде бы чистым синтаксисом.

Меньше слов

Избегайте написания в комментариях новел. Часто в CSS очень хочется объяснить как можно подробнее, но на самом деле это не всегда нужно. Чем короче и емче вы напишите, тем лучше.

Совет по наименованию классов, которые помогут вам избежать слишком объемного комментирования: придумывайте названия настолько короткие, насколько это возможно, но не забывайте что они могут быть длинными настолько, насколько это необходимо. Это же будет справедливо сказать и о комментариях.

Можете проверить себя, представьте, что вы ничего не знаете о коде и просто прочитайте только комментарии, если они сложились в одну понятную историю, значит они будут понятны не только вам. Или Вы можете посетить курсы HTML

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

Курсы изучения HTML: edu.cbsystematics.com/ru/courses/description/html-css и itvdn.com/ru/Video/html5-and-css3

 


Читайте:


Золото с привкусом липы

Несмотря на ежегодное сокращение числа школьников, количество медалистов в российских школах год от года растет. Причем кое-где ...

Обычная озлобленность раба

Между менеджером и тружеником никогда не будет понимания. И потому все, или почти все инициативы нашего правительства - бесплодн...

Открытый урок - Наркомания - что это?

Болезненное влечение или пристрастие к наркотическим веществам, употребляемым различными способами (глотание, вдыхание, внутриве...

О толерантности

В последние годы все активнее навязывается нам некая «толерантность» как тип поведения современного человека, который способству...

Новая школа

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

Учителями славится Россия

Говорят, что труд учителя - удел энтузиастов, которые с детства видели себя в роли наставника, мечтали сеять разумное, доброе...

Составление ребусов и кроссвордов

Составление ребусов – задача сложная и интересная, как для ученика, так и для учителя. Для учащихся – это возможность самовыраж...

Про мотивацию

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

Авторизация





Собрать в школу ребёнка:

Школьный костюм

News image

Итак, приготовьтесь к тому, что на проводы ребенка в школу уйдет около 5 000 до 6500 рублей, если покупать не самые дорогие, но и не самые дешевые в...