多行 CSS 评论有最佳实践吗?
Is there a best practice for multi-line CSS comments?
有时,当我发现 CSS 评论跨越多行时,我看到它们缩进了 space 或 space 和星号。我发现这些更具可读性,但 the CSS specifications 中没有提及它们。缩进 CSS 评论更好,还是只添加 /*
和 */
字符串而不更改评论文本更好?
示例:
/*
The quick
brown fox
jumps over
the lazy dog.
*/
/*
* The quick
* brown fox
* jumps over
* the lazy dog.
*/
/*
The quick
brown fox
jumps over
the lazy dog.
*/
没有一个最佳实践是每个人都做的。但我想每个人都会同意这些:
- 说清楚。找到一个易于阅读的布局,不要让您的注释混淆代码。
- 保持一致。不要在不同的地方做不同的事情。尽管您可能有一种方法对整个声明进行注释,而另一种方法用于单个 属性(例如,您可以将后者放在同一行的 属性 之后。)
有时,当我发现 CSS 评论跨越多行时,我看到它们缩进了 space 或 space 和星号。我发现这些更具可读性,但 the CSS specifications 中没有提及它们。缩进 CSS 评论更好,还是只添加 /*
和 */
字符串而不更改评论文本更好?
示例:
/*
The quick
brown fox
jumps over
the lazy dog.
*/
/*
* The quick
* brown fox
* jumps over
* the lazy dog.
*/
/*
The quick
brown fox
jumps over
the lazy dog.
*/
没有一个最佳实践是每个人都做的。但我想每个人都会同意这些:
- 说清楚。找到一个易于阅读的布局,不要让您的注释混淆代码。
- 保持一致。不要在不同的地方做不同的事情。尽管您可能有一种方法对整个声明进行注释,而另一种方法用于单个 属性(例如,您可以将后者放在同一行的 属性 之后。)