[wp-trac] [WordPress Trac] #28551: Add Better Debugging Documentation Into wp-config.php

[WordPress Trac]

#28551: Add Better Debugging Documentation Into wp-config.php
-------------------------------+-----------------------------
 Reporter:  philiparthurmoore  |       Owner:
     Type:  enhancement        |      Status:  new
 Priority:  normal             |   Milestone:  Future Release
Component:  Bootstrap/Load     |     Version:
 Severity:  normal             |  Resolution:
 Keywords:  needs-patch        |     Focuses:  docs
-------------------------------+-----------------------------

Comment (by rmccue):

 Replying to [comment:6 helen]:
 > Replying to [comment:5 siobhan]:
 >
 > I would use single-line comments (`//` instead of `/* */`) for the line
 with the constant, otherwise it's very tedious to uncomment and use the
 constant.

 Agreed. Personally, I actually like using hash comments (`#`) for lines of
 code that can be commented/uncommented, as it makes it clear what's a
 comment and what's a disabled line of code. Whether we want to actually
 use that pattern, I don't know. :)

 I'm also thinking there's probably not much point repeating the constant
 name itself, since it's on the line straight afterwards.

 Thinking something like this:
 {{{
 /**
  * Turn on/off debugging mode.
  * Default: false.
  */
 # define('WP_DEBUG', true);
 }}}

--
Ticket URL: <https://core.trac.wordpress.org/ticket/28551#comment:7>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform