[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 needs-patch  |  
--------------------------------+-------------------------------------------
Changes (by jacobsantos):

  * keywords:  phpdoc has-patch => phpdoc needs-patch

Comment:

 WTF?

 What is the difference between:

 {{{
 // The name of the database for WordPress
 define('DB_NAME', 'putyourdbnamehere');
 }}}

 And

 {{{
 /** The name of the database for WordPress */
 define('DB_NAME', 'putyourdbnamehere');
 }}}

 Answer: The phpDocumentor sites don't pick up the first one, while they do
 with the second one.

 Riddle me this: What is the difference between these two comments?

 {{{
 <?php
 // This file holds the configuration of WordPress.
 }}}

 And

 {{{
 <?php
 /**
  * This file holds the configuration of WordPress.
  */
 }}}

 At the very least, the file level phpdoc should be kept.

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