.config/coc/extensions/node_modules/coc-prettier/node_modules/stylelint/lib/rules/comment-whitespace-inside/README.md

   1 # comment-whitespace-inside
   2
   3 Require or disallow whitespace on the inside of comment markers.
   4
   5 ```css
   6     /* comment */
   7 /**  ↑         ↑
   8  * The space inside these two markers */
   9 ```
  10
  11 Any number of asterisks are allowed at the beginning or end of the comment. So `/** comment **/` is treated the same way as `/* comment */`.
  12
  13 **Caveat:** Comments within *selector and value lists* are currently ignored.
  14
  15 ## Options
  16
  17 `string`: `"always"|"never"`
  18
  19 ### `"always"`
  20
  21 There *must always* be whitespace inside the markers.
  22
  23 The following patterns are considered violations:
  24
  25 ```css
  26 /*comment*/
  27 ```
  28
  29 ```css
  30 /*comment */
  31 ```
  32
  33 ```css
  34 /** comment**/
  35 ```
  36
  37 The following patterns are *not* considered violations:
  38
  39 ```css
  40 /* comment */
  41 ```
  42
  43 ```css
  44 /** comment **/
  45 ```
  46
  47 ```css
  48 /**
  49  * comment
  50  */
  51 ```
  52
  53 ```css
  54 /*     comment
  55 */
  56 ```
  57
  58 ### `"never"`
  59
  60 There *must never* be whitespace on the inside the markers.
  61
  62 The following patterns are considered violations:
  63
  64 ```css
  65 /* comment */
  66 ```
  67
  68 ```css
  69 /*comment */
  70 ```
  71
  72 ```css
  73 /** comment**/
  74 ```
  75
  76 The following patterns are *not* considered violations:
  77
  78 ```css
  79 /*comment*/
  80 ```
  81
  82 ```css
  83 /****comment****/
  84 ```