DEV Community

Discussion on: Why do I hate external things in programming?

 
athomsfere profile image
Austin French

Comments, in general? Or comments similar to that?

I'm of the camp: Comments should explain what your code can't.

    /// 3rd party library has a "bug" which requires this format
Enter fullscreen mode Exit fullscreen mode

If you mean: Using that style of commenting for a single line of comments, then:

1) Almost every style guide I've seen would call that a bad practice. It should be fixed
2) In compiled languages, at least it has no impact as generally the compiler will drop comments.

Thread Thread
 
baenencalin profile image
Calin Baenen

No, I meant w/ doc-comments, it forces me to have a space on all (comment) lines below the start, yet doesn't align the top (starting) line.

Refer to what I sent in the code block to resolve any questions, and ask you're still confused.