[buddypress-trac] [BuddyPress] #2344: PHP comments inside functions

buddypress-trac at lists.automattic.com buddypress-trac at lists.automattic.com
Mon Apr 26 17:38:46 UTC 2010


#2344: PHP comments inside functions
-----------------------------+----------------------------------------------
 Reporter:  johnjamesjacoby  |       Owner:                
     Type:  enhancement      |      Status:  new           
 Priority:  normal           |   Milestone:  Future Release
Component:  Core             |    Keywords:                
-----------------------------+----------------------------------------------
 For the past few versions we've started using comment blocks:
 {{{
 /* Comment */
 }}}
 ...even when inside functions or comments are only one line long.

 I've noticed during testing that this makes it hard to comment out a large
 chunk of code because you need to comment code both before and after it.

 I suggest that we move all code comments that are inside of each function
 to single line comments instead:
 {{{
 // Comment
 }}}

 A simple sweep of the code to change the comment blocks (while not
 entirely productive) will help testing core code chunks easier.

-- 
Ticket URL: <https://trac.buddypress.org/ticket/2344>
BuddyPress <http://buddypress.org/>
BuddyPress


More information about the buddypress-trac mailing list