欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

BootstrapCSS编码规范讲解之注释实例

程序员文章站 2022-11-28 08:40:00
注释 代码是由人编写并维护的。请确保你的代码能够自描述、注释良好,且易于他人理解。好的代码注释能够传达上下文关系和代码意图。不要简单地重复组件或 class 的名称。 对于较长...

注释

代码是由人编写并维护的。请确保你的代码能够自描述、注释良好,且易于他人理解。好的代码注释能够传达上下文关系和代码意图。不要简单地重复组件或 class 的名称。

对于较长的注释,务必书写完整的句子;对于一般性注解,可以书写简洁的短语。

/* Bad example */
/* Modal header */
.modal-header {
  ...
}
/* Good example */
/* Wrapping element for .modal-title and .modal-close */
.modal-header {
  ...
}