remove #include comments #10472
Closed
remove #include comments #10472
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4294b8d to
95c38a5
Compare
Merged
Several PHP maintainers have argued that code comments explaining include directives are bad. - @dstogov wrote "It adds almost useless comments that are not goigg to be kept as to date" https://marc.info/?l=php-internals&m=167403155727727&w=2 - @derickr wrote "Adding comments that go out of date as to why a header is included is also clutter." https://marc.info/?l=php-internals&m=167405646312575&w=2 - @kamil-tekiela wrote "I am against putting comments on #includes. Comments are noise in code and often go out of date." https://marc.info/?l=php-internals&m=167406432218721&w=2 I don't agree with them; I believe that code comments help others understand and maintain the code. Of course, like any code comment, they become obsolete and wrong, but outdated comments are still better than no comment at all. With this argument, you can easily say that nobody should ever write a code comment. My RFC https://wiki.php.net/rfc/include_cleanup contains a vote on whether #includes are allowed to have explanatory code comments; if this is denied, then please merge this PR to get rid of many existing comments which my work has imitated.
95c38a5 to
f667717
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Several PHP maintainers have argued that code comments explaining include directives are bad.
@dstogov wrote "It adds almost useless comments that are not goigg to be kept as to date" https://marc.info/?l=php-internals&m=167403155727727&w=2
@derickr wrote "Adding comments that go out of date as to why a header is included is also clutter." https://marc.info/?l=php-internals&m=167405646312575&w=2
@kamil-tekiela wrote "I am against putting comments on #includes. Comments are noise in code and often go out of date." https://marc.info/?l=php-internals&m=167406432218721&w=2
I don't agree with them; I believe that code comments help others understand and maintain the code. Of course, like any code comment, they become obsolete and wrong, but outdated comments are still better than no comment at all. With this argument, you can easily say that nobody should ever write a code comment.
My RFC https://wiki.php.net/rfc/include_cleanup contains a vote on whether #includes are allowed to have explanatory code comments; if this is denied, then please merge this PR to get rid of many existing comments which my work has imitated.