Bug 68256 – CodeGeneratorGObject should use C++ style comments for ENABLE guards

• Status: RESOLVED
• Resolution: WONTFIX
• Component: New Bugs

[Adam Barth]

CodeGeneratorGObject should use C++ style comments for ENABLE guards

[Adam Barth]

Created attachment 107680 [details]
Patch

[Darin Adler]

Comment on attachment 107680 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=107680&action=review

> Source/WebCore/bindings/scripts/CodeGeneratorGObject.pm:58
> + * This file is part of the WebKit open source project.
> + * This file has been generated by generate-bindings.pl. DO NOT MODIFY!

Not specific to this patch, really, but I don’t think that adding stars to every line improves this comment. In fact, I think this format should be considered an anti-pattern in the future. Those additional stars make it slightly easier to spot that it's a comment, but also make comments harder to edit with any non-advanced editing tools.

If we really want something on every line, then we should just use // comments. The whole benefit of /* */ comments is that they are multiline without requiring additional characters on every line.

[Adam Barth]

Ok.  I'll change them to //, which is also a common style for license blocks in the project.  I'm not sure it's such a big deal for these generated files.  Mostly it was the ENABLE-guard comments that I bumped into.

[Adam Barth]

Committed r95304: <http://trac.webkit.org/changeset/95304>

[Ryosuke Niwa]

I had to roll this patch out because GTK+ pulls the derived headers in main.c.

[Adam Barth]

Whatever.  This is too much work for too little benefit.

[Ryosuke Niwa]

(In reply to comment #6)
> Whatever.  This is too much work for too little benefit.

Yeah, I completely agree.