search

mbrukman / autogen

Automatically generate boilerplate license comments.
Apache License 2.0
98 stars 27 forks source link

Split header license comment from TODO comment #12

Closed mbrukman closed 7 years ago

mbrukman commented 8 years ago

Offline feedback from a user:

Separating the license header from the "// TODO general file description" comment with a blank line would allow IDEs to collapse just the license boilerplate, yet show the actually useful general description comment. Right now that blank line starts with a comment separator, which causes IDEs to fold the TODO line too.

This would be a simple change, but will be backwards-incompatible, which we need to carefully consider, if folks are currently relying on this aspect of functionality.

One option is making a release immediately prior to this change, and annotate the change in behavior with the following release.

mbrukman commented 7 years ago

This has been fixed: the new default behavior is to leave a blank line and the --separator flag exists to provide the previous behavior of inserting a line of comment characters.