According to Drupal coding standards, comments should follow CSSDoc syntax.

This is how currently comments are formatted:

/* --------------- Commnet ------------ */

And here is how it should look like:

/**
* Comment.
*/
CommentFileSizeAuthor
#3 bartik-CSScomments.patch9.95 KBtlattimore

Comments

tlattimore’s picture

tlattimore commented
Assigned: Unassigned » tlattimore

I agree, the comments should follow the standard that is documented. On it!

tlattimore’s picture

tlattimore commented
Assigned: tlattimore » Unassigned

Blast it! Change the comments as requested, made a patch, than realized I hadn't check out the latest version of HEAD. Unfortunately I don't know if i'll have any other time to work on this. Un-assigning.

tlattimore’s picture

tlattimore commented
StatusFileSize
new bartik-CSScomments.patch9.95 KB

Here is a patch that makes the requested changes.

tlattimore’s picture

tlattimore commented
Status: Active » Needs review

Tagging

jensimmons’s picture

jensimmons commented
Status: Needs review » Closed (won't fix)

The Drupal CSS coding standards are a draft, not a final for-sure. And most front-end developers I know do not follow them. Sadly, it seems the discussion of how to format CSS was taken over by PHP coders, and the professional CSS experts lost. I believe CSS should be formatted as CSS, not PHP. So that's why Bartik is formatted the way it is. Hopefully at some point the Drupal coding standard draft will be revisited and revised.

jarek foksa’s picture

jarek foksa commented
Status: Closed (won't fix) » Active

Just like with file structure thing, using CSSDoc syntax makes a lot of sense to me because all other core modules and themes are already doing this. It's used in core not just for PHP files, but also for JavaScript and CSS.

Besides I don't think that it's very professional to type 40 dashes each time when you put a comment :P

jarek foksa’s picture

jarek foksa commented
Status: Active » Closed (won't fix)

Uhm... I didn't mind to change the status, I'm not deciding here what gets committed or not.

kevinquillen’s picture

kevinquillen commented

I would agree with #6.

If this is going to be in the core, I would think that it shouldn't be any different from the rest of the structure/code of things in Drupal 7. Module submissions are pretty strict on following standards in the handbook.