The coding standards recommend two different methods of inserting header comment blocks:

- http://drupal.org/node/318 (Coding standards page) recommends: /* $Id$ */
- http://drupal.org/node/546 (Header comment blocks page) recommends: // $Id$

I checked the files in core, and it seems that the // $Id$ notation is more common, so is probably supposed to be the standard followed? If that's the case, 318 should probably be updated to reflect this since that appears on the surface at least to be an "all-in-one" document for coding standards... I would guess that most users don't even hit the second page. But in either case, it would be nice to know which method is preferred.

CommentFileSizeAuthor
#4 CODING_STANDARDS.html.patch771 byteswebchick

Comments

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented

I noticed today that all the files in core are now changed to the // $Id$ style for consistency, so the fix for this issue would be:

http://drupal.org/node/318

Change:

<?php
/* $Id$ */

to:

<?php
// $Id$

and:

<?php
/* $Id: CODING_STANDARDS.html,v 1.4 2004/10/27 11:55:32 uwe Exp $ */

to:

<?php
// $Id: CODING_STANDARDS.html,v 1.4 2004/10/27 11:55:32 uwe Exp $
cel4145’s picture

cel4145 commented

It appears that the particular handbook page in question uses php to pull the coding standards from a location in Drupal CVS:

http://cvs.drupal.org/viewcvs/*checkout*/drupal/contributions/CODING_STA...

Could someone with CVS access implement this update to the coding standards text?

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
Status: Active » Fixed

Hey cool! Something I can actually do! :D Updated.

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
Status: Fixed » Needs review
StatusFileSize
new CODING_STANDARDS.html.patch771 bytes

Actually that didn't seem to work. http://drupal.org/node/318 still shows the "old way."

Attached is the patch I used to change the CODING_STANDARDS.html file in CVS. Could someone with permissions change the handbook page?

drewish’s picture

drewish commented

Patch does what it says, +1.

dries’s picture

dries commented
Status: Needs review » Fixed

This has been fixed.

Anonymous’s picture

(not verified) commented
Status: Fixed » Closed (fixed)