[wp-trac] Re: [WordPress Trac] #7526: WP-Config-Sample.php inline documentation

[WordPress Trac]

#7526: WP-Config-Sample.php inline documentation
------------------------------+---------------------------------------------
 Reporter:  santosj           |        Owner:  anonymous
     Type:  enhancement       |       Status:  reopened 
 Priority:  low               |    Milestone:  2.7      
Component:  Optimization      |      Version:           
 Severity:  minor             |   Resolution:           
 Keywords:  phpdoc has-patch  |  
------------------------------+---------------------------------------------
Comment (by caesarsgrunt):

 I agree with [comment:4 westi] and [comment:7 Viper007Bond].

 PHPdoc is great in the core WP files, which will only be seen by
 developers. However, it really does make this file too cluttered and could
 easily confuse the average user.

 I propose reverting [8655].

 This isn't to say it should be left as it was before, just not PHPdoc or
 such in-depth dev-only detail.

 eg instead of
 {{{
 /**
  * The name of the database.
  *
  * @var string
  * @since unknown
  */
 define('DB_NAME', 'putyourdbnamehere');
 }}}
 how about
 {{{
 // The name of the database for WordPress
 define('DB_NAME', 'putyourdbnamehere');
 }}}

-- 
Ticket URL: <http://trac.wordpress.org/ticket/7526#comment:10>
WordPress Trac <http://trac.wordpress.org/>
WordPress blogging software