Хороший стиль кодирования может помочь нам иметь четкие идеи при создании веб-страниц, а комментарии к коду также содержат некоторые небольшие знания.
Я обобщил стандарты написания аннотаций, которые использовал в своей работе. На самом деле технического содержания нет. Главное уделять внимание стандартам, что облегчает единый метод производства и облегчает обслуживание.
Эти возможности включают четыре части: «Комментарии к регионам», «Однострочные комментарии», «Уровни комментариев» и «Вспомогательные комментарии». Метод аннотации области, используемый большинством друзей, начинается с «содержимого аннотации» или «конца содержимого аннотации», «начала» или «конца» и т. д. Для сравнения, начать с «S» или «E» может быть быстрее. используйте, например, просто напишите начальный или конечный комментарий один раз, затем скопируйте его и измените «S» или «E», чтобы быстро завершить комментарий в этой области.
В реальной работе иногда неясно, должна ли аннотация располагаться над или под меткой. Чтобы избежать этой ситуации, информация аннотации записывается единообразно до и после начала и конца метки региона, и ей предшествует буква «S». « или
«
E» начинается, обозначая начало или конец аннотации области.Пример:
<!--=Содержимое комментария S-->
<дел>
...
</div>
<!--=E Содержание комментария-->
/*=S Содержание комментария*/
.сорт{
...
}
.сорт{
...
}
/*=E Содержимое комментария*/
однострочного комментария
должна быть записана в области содержимого, которую необходимо прокомментировать.
Пример:
<div>.
<!--Содержимое комментария-->
...
</div>
.класс{
/*Содержимое комментария*/
...
}
Уровень аннотаций
При производстве модулей могут существовать области внутри областей. Чтобы лучше различать уровни между областями, вводится понятие уровня аннотаций. Знак равенства перед комментарием к области указывает уровень текущего комментария.
Пример:
<!--=S содержание комментария-->.
...
<!--==S Содержание комментария-->
...
<!--===S Содержание комментария-->
...
<!--===E Содержание комментария-->
...
<!--==E Содержание комментария-->
...
<!--=E Содержание комментария-->
/*=S Содержание комментария*/
...
/*==S Содержание комментария*/
...
/*===Содержимое комментария S*/
...
/*===E Содержание комментария*/
...
/*==E Содержимое комментария*/
...
/*=E Содержимое комментария*/
Помогает комментировать
идентификационную информацию, такую как время модификации и модификатор, добавленный, если он поддерживается неавторами. Добавьте модификатор, время модификации и другую информацию на основе комментария к области или однострочного комментария.
Пример (комментарий к региону):
<!--==Содержимое комментария S [модификатор и время изменения] -->
<дел>
...
</div>
<!--==E Содержимое комментария [модификатор и время модификации]-->
/*=S Содержимое комментария [модификатор и время модификации]*/
.сорт{
...
}
.сорт{
...
}
/*=E Содержимое комментария [модификатор и время модификации]*/
Пример (однострочный комментарий):
<div>
<!-- Содержимое комментария [модификатор и время изменения] -->
...
</div>
.класс{
/*Содержимое комментария [модификатор и время модификации]*/
...
}