Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
-
@njpugh90 Is that what this is?
Kill it with fire. I don't know who thought putting spaces between the method name and capitalizing the first word would help anyone. Sure, it may be a placeholder, but either the coder will document, or they'll leave that shit there that does nothing but suck ass. It'd be better with no documentation at all...
Related Rants
every single fuckening day
How documentation works
The best kinds of comments:
/**
Gets user CC info datas.
*/
public Object getUserCCInfoDatas() {}
If you really want to outdo yourself:
/**
Gets user CC info datas.
@param someshit Outdated docs ftw
*/
public Object getUserCCInfoDatas(String unrelatedToDocAbove) {}
Honestly, no documentation is better in some cases. At least I can't be angry about their shitty quality... And they don't waste my time.
rant
documentation
kill it with fire