Relative Content

Tag Archive for comments

Is there a need to comment obvious parameters? [duplicate]

This question already has answers here: Is it necessary to write a javadoc comment for EVERY parameter in a method’s signature? (7 answers) Closed 9 years ago. Most of the time, when I comment a method, I’ll follow this structure. /** * Short description of what the method does * * @param {Type} name. Description […]

Should I mark what blocks mean in data-* attributes?

I was writing a webpage today with a comment after the start of every major section. Instead of using a comment, which comes with the bulgy <!-- --> syntax, could I instead put this in a data-* attribute? This would be more for me than anything else, so I don’t want to put it in an id or class, but it would also leave it open for userscripts to more easily parse the page.

Should I mark what blocks mean in data-* attributes?

I was writing a webpage today with a comment after the start of every major section. Instead of using a comment, which comes with the bulgy <!-- --> syntax, could I instead put this in a data-* attribute? This would be more for me than anything else, so I don’t want to put it in an id or class, but it would also leave it open for userscripts to more easily parse the page.

Should I mark what blocks mean in data-* attributes?

I was writing a webpage today with a comment after the start of every major section. Instead of using a comment, which comes with the bulgy <!-- --> syntax, could I instead put this in a data-* attribute? This would be more for me than anything else, so I don’t want to put it in an id or class, but it would also leave it open for userscripts to more easily parse the page.

Should I mark what blocks mean in data-* attributes?

I was writing a webpage today with a comment after the start of every major section. Instead of using a comment, which comes with the bulgy <!-- --> syntax, could I instead put this in a data-* attribute? This would be more for me than anything else, so I don’t want to put it in an id or class, but it would also leave it open for userscripts to more easily parse the page.