Do all the things like ++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatarSign Up
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple APILearn More
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
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
It's kinda calming to find out that the atlassian-guys themselves don't know very good about their stuff either3
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
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?
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
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
Sometimes when other devs ask me to explain something in the specs I cannot make into smaller words (example: javadoc says throws <error name> when x <= y. I was asked to explain 'what all this psuedocode means'), or their code horrifies me, I ask my mother if she knows what it is doing.... just as a 'wtf am I missing' check.
She still finds it amazing when we text her a gif and asks for help when she 'loses' her icons on her phone, but she will still ask what is wrong with some of these people.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.
I hate doc comments in Rust. They are literally just markdown without any special syntax for documenting stuff. What the actual fuck. Why can't everbody just straight up copy how javadoc does it 😭9
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.
Developing plugins for IntelliJ is a very cool thing most of the time. I mean they made an amazing job building the infrastructure for messaging and so on.
But some things are not really documented, you have to go through existing code or search for javadoc.
So its like half of the time you feel amazing while coding and then you need something not that obvious and you are stuck with an easy task. After some hour of frustation you find a cool way to solve it and the show goes on.
Its like driving in a rollercoaster of (coding) emotions. But that makes it feel like an adventure or sth ...
And there I was thinking Maven is going to make life simpler, with this granular dependency management and IDE independence (no extraneous classpath and module management required). But wait, it turns out that to run simple Ant task I need all my dependencies to have *.pom. Every. Fricking. Dependency.
I mean, sure, only if I knew which sub-dependencies they all had, but that seems like heck a lot of work to make external JAR libraries to work with Maven process.
WHY TODAY? Yesterday I had no issue: uploaded few libraries in corporate repository, refreshed index, dependencies downloaded, even had time appending javadoc to one of them and it worked. But today is the day, right? I just run simple task with maven-antrun-plugin (mvn antrun:run@<executionID>), and it starts scanning each dependency for *.pom file. I DON'T WANT THIS. Google, help me. Oh, no direct answers and clues?
Just... fuck you, Maven. With all 2 days effort I could just litter in IDE's classpath, write build.xml in no time, make normal webservice, but that would require me to also litter sources with required libraries. FML!4
When the documentation consists only out of JavaDoc boilerplate, providing exactly NO additional information and just clutters the code.
Writing javadocs for interfaces with quite complicated methods all day is so fucking exhausting. Programming itself is so much easier than documenting the written code clearly and precicely so that everyone understands it.