[drupal-docs] [bug] Ambiguity re: how to write header comment blocks
webchick
drupal-docs at drupal.org
Fri Aug 5 04:10:26 UTC 2005
Issue status update for
http://drupal.org/node/28251
Post a follow up:
http://drupal.org/project/comments/add/28251
Project: Documentation
Version: <none>
Component: Developer Guide
Category: bug reports
Priority: minor
Assigned to: Anonymous
Reported by: webchick
Updated by: webchick
Status: active
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.
webchick
More information about the drupal-docs
mailing list