Do all the things like ++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatarSign Up
Get a devDuck
Rubber duck debugging has never been so cute! Get your favorite coding language devDuckBuy Now
Search - "javadoc"
Started working on a new project.
Sent out my first code review for that repo.
An intern pinged me and blamed me that I have added so many comments to get more lines of code.
I have no words to reply him.4
Dear Java library developers. The javadoc is not an excuse to not write documentation.
a very annoyed golang developer
Just when i somehow accepted that Austrian part of team is naming theirs methods in Deutch, i almost got heart attack when i saw this. They're combining english with deutch, for example isOffen(), isLoeschenAllowed(), isEinsichtHinzufuegenAllowed() and so on... And most of the time these assholes even dont add javadoc, but when they do it something like: "Checks if *curentClass* is offen". Thanks a fucking ton.3
It's kinda calming to find out that the atlassian-guys themselves don't know very good about their stuff either3
The people who developed JAutodoc should be punished. The people who use JAutodoc should be punished harder. And the bosses who force their employees to javadoc each function should be punished the hardest ...
- some random wise guy on the internet
Gotta revise MySQL and Java for my IT Matura exam on Wednesday...
Reading/writing from/to files in a Java 8 manner,
LOAD DATA (LOCAL) INFILE "blah.csv" LINES TERMINATED BY "\r\n" DELIMITED BY ";' etc.,
clean Eclipse install...
No Internet, I'll have javadoc and mycli though.26
Apache Jena Documentation is SAVAGE
when looking through their Node documentation I could sense the sweat and rotten despair of the devs.
The documentation can found in https://jena.apache.org/documentati...1
Upon returning from vacation, the chief abbot of the Laughing Monkey Clan found his temple in a state of panic and disarray. The financial system they had just modified was throwing NullPointerExceptions for all new customers. These users, disquieted in the extreme, were terminating their accounts after barely a day.
With some difficulty the abbot traced the problem to a method whose stated purpose was to return a List of the user’s transactions. If there were no transactions it returned null, rather than the empty list.
“Bring me the monk who wrote this method,” he told the temple guards. “And also the monk whose code invokes it.”
The first monk, who was the elder of the two, declared that the blame should be placed squarely at the feet of the second. “My Javadoc was clear in the extreme. It is not my fault that he did not check for nulls.” The second monk hung his head in shame and said nothing.
The abbot clapped his hands and two tall jade urns were set upon the floor, one before each monk. “Your punishments have been written on slips of paper within. Each day you are to remove the first slip your hand touches and obey its decree to the letter, until your urn is empty.”
The younger monk was bade go first. His hand had not gone halfway into the urn when the rustling of paper was heard. Reading the slip, he bowed and left the room.
The elder monk reached deep into his own urn until his fingers brushed the cold bottom. “There are no slips of paper in this urn,” said the monk, the slightest smile playing at the corner of his mouth.
“Neither are there fish, nor ten mountains,” said the abbot.
The elder monk then cried out in pain. The urn fell over and shattered. A scorpion scuttled away across the tiles.
The abbot regarded the dying monk. “All nothings are not equal.”
In the project I'm working on with others, really complex and confusingly programmed, there's a method called "check[...]IsSet". It gives back a string. They went out of their way to write a Javadoc for it and what does it say?
"@return the string"
No, really? I think I could have figured that out by myself! But what's in it, dammit?
I am really fed up with people emailing me asking about how they can use methods of a library I wrote when the answer is literally in the f***ing JavaDoc. At first I thought it might be me not being comprehensive enough in my doc, but when I literally started sending copies of what I wrote there and got a lot of "Thanks that makes it clear"emails I became really fed up with the laziness of some people. I find it disrespectful to my weeks of work for someone who wants to use it to not read a few lines when in doubt.1
Fuck undocumented shit!
I was wondering how to use this one method of the "interface". Googled the name of the program and the specific method.
Got two results.
From the same page.
It's a comment complaining that this shit is undocumented and doesn't work.
If you build something that others use, please, motherfucking please, document your code.
At least some auto generated javadoc, how hard can it be?
You are using the atlassian suite for everything and you have confluence so use it already! The only documentation that actually exists it about a hundred years old, totally useless and covers about 1% of what your product can do.
I like your product but fuck me sideways your documentation sucks balls! Fuck!
That needed to get out.
Spent half a day trying to setup a proper javadoc aggregation mechanism for a multi module gargle project. Urgh.. Why isn't there a good plugin to do this?
Can someone help me if they are aware of an existing plugin that works for gargle to do this?
Tried nexus aggregator for gradle. Doesn't work
Inherited a project from my lecturer. He's been working on it since 2014. Over 200 classes and not a single line of javadoc. He's even written his own library code for things like task executors. Sometimes I wonder what obscure deity I pissed off in my past life to deserve this 😂😥
I once did this project with Apache Tika, which also has a batch module to add concurrency (Tika by itself is not thread-safe).
However, there is maybe 2 pages of documentation which don't explain any of the classes etc, and no javadoc, so I had to figure everything out through trial and error. At the end it still threw an error but magically worked. Turns out it was not fast enough anyway.
When the documentation consists only out of JavaDoc boilerplate, providing exactly NO additional information and just clutters the code.