russplaysguitar / navel

Working towards a linter for cfscript
MIT License
2 stars 0 forks source link

JavaDoc style comments #26

Open atuttle opened 11 years ago

atuttle commented 11 years ago

I believe strongly that comments should not affect code execution. If I were going to use a CFScript linter, I would definitely disallow them.

I agree that they look better than function metadata as weird name/value pairs after the argument list... but I'd rather explain ugly syntax to a new programmer than that only a certain type of comments affect the way code executes.

russplaysguitar commented 11 years ago

:+1:

russplaysguitar commented 11 years ago

I'm in favor of lint failure when using these. Anyone feel strongly otherwise?

adamcameron commented 11 years ago

I'm ABSOLUTELY AGAINST any form of comment that actually has an impact on how code runs. It's just wrong. And it was completely wrong of Adobe to implement "special comments" in CFML to control how some stuff in CFCs work. Not only should the lint thing fail these, it should pass electricity through whoever had the idea to implement them in the first place.

Sorry, just putting "me too" didn't express my opinion strongly enough ;-)