6.0.0-beta1
7/5/25

[#8193] prefer C style comments rather than C++ ones for configurations files
Summary prefer C style comments rather than C++ ones for configurations files
Queue Horde Framework Packages
Queue Version FRAMEWORK_3
Type Enhancement
State No Feedback
Priority 1. Low
Owners
Requester pedretti (at) eco (dot) unibs (dot) it
Created 04/15/2009 (5925 days ago)
Due
Updated 06/01/2009 (5878 days ago)
Assigned
Resolved 06/01/2009 (5878 days ago)
Milestone
Patch No

History
06/01/2009 07:56:53 PM Chuck Hagenbuch State ⇒ No Feedback
 
04/17/2009 04:02:12 AM Chuck Hagenbuch Comment #5 Reply to this comment
I don't remember anything other than what Michael R. said.
04/16/2009 10:27:13 PM Michael Rubinsky Comment #4 Reply to this comment
FWIW, I remember discussion about avoiding problems with the 
individual section headers being commented with the /* */ style.  In 
other words we settled on using the 'C' style comments to comment out 
unwanted code to avoid inadvertently ending a comment if using the C++ 
style.
04/16/2009 10:21:46 PM Jan Schneider Comment #3
State ⇒ Feedback
Reply to this comment
I'm pretty sure there was a good reason for this type of commenting 
out, but I can't recall it right now. Chuck, do you remember the reason?
04/16/2009 08:24:02 PM Michael Slusarz Comment #2 Reply to this comment
Patches would be great.
04/15/2009 02:37:43 PM pedretti (at) eco (dot) unibs (dot) it Comment #1
Priority ⇒ 1. Low
Type ⇒ Enhancement
Summary ⇒ prefer C style comments rather than C++ ones for configurations files
Queue ⇒ Horde Framework Packages
Milestone ⇒
Patch ⇒ No
State ⇒ New
Reply to this comment
Some configuration files (e.g. turba/config/sources.php.dist) have 
some sections (e.g. localldap) that are disabled by commenting out 
every single line with a // .



It would be better to change the commenting of these section using C 
style comments /*  */ . The main reason is that when upgrading to a 
newer module version, it's easy to integrate your own changes (usually 
a few line) using the diff/patch commands.



E.g. if I uncomment all the lines of the localldap section and then I 
modify only the server line I can do a diff between the .php.dist and 
the .php version and I would have only three lines changed (the 
starting comment /* , the server line and the ending */ comment ). 
With the // style comment I get tens of changed lines, to manually 
review, before applying the .php.dist -> .php patch to the newer 
module version, since the skeleton config section may have been changed.



Thanks

Saved Queries