Opened 15 years ago
Closed 9 years ago
#2344 closed enhancement (wontfix)
PHP comments inside functions
Reported by: |
|
Owned by: |
|
---|---|---|---|
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.
9 years ago
#4
@
9 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.
Not guaranteed to be acted on, but will evaluate.