Skip to:
Content

BuddyPress.org

Opened 14 years ago

Closed 8 years ago

#2344 closed enhancement (wontfix)

PHP comments inside functions

Reported by: johnjamesjacoby's profile johnjamesjacoby Owned by: tw2113's profile tw2113
Milestone: Priority: normal
Severity: normal Version:
Component: Core Keywords:
Cc:

Description

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.

Change History (5)

This ticket was mentioned in Slack in #buddypress by tw2113. View the logs.


8 years ago

#2 @tw2113
8 years ago

  • Owner set to tw2113
  • Severity set to normal
  • Status changed from new to assigned

#3 @tw2113
8 years ago

Not guaranteed to be acted on, but will evaluate.

#4 @DJPaul
8 years ago

I think you can close. Not sure if WP bothered documenting this aspect in their coding styles, but in the modern BuddyPress code, I'm pretty sure we've all come to standardise on // for comments over one (or two) lines, and /* for multi-lines.

#5 @DJPaul
8 years ago

  • Milestone Future Release deleted
  • Resolution set to wontfix
  • Status changed from assigned to closed
Note: See TracTickets for help on using tickets.