Also, for how to write comments, please look at Spring or SpringBoot code base. Just an example file : https://github.com/spring-projects/spring-framework/blob/master/spring-beans/src/main/java/org/springframework/beans/BeanUtils.java
On Fri, Jun 5, 2020 at 4:09 PM Gurkan Erdogdu <cgurkanerdo...@gmail.com> wrote: > Look at > https://github.com/apache/openwebbeans/blob/master/webbeans-impl/src/main/java/org/apache/webbeans/service/ClassLoaderProxyService.java > > > > On Fri, Jun 5, 2020 at 12:46 PM Mark Struberg <strub...@yahoo.de.invalid> > wrote: > >> We intentionally removed comments which do not add any value. >> >> Just check the history. We deleted many @inheritdoc without any >> additional information. >> Or JavaDoc like /** sets the blablub */ for setBlablub(); >> >> It just adds useless lines of code and results in 30% more code one has >> to parse when reading it. >> Of course, javadoc which describes WHY and HOW we do it is highly welcome! >> >> Back in the early 2000 there have been metrics for code which misses >> JavaDocs. This mantra is refuted since a long time. >> I'm sure there are plenty of other tasks which make perfect sense. >> >> LieGrue, >> strub >> >> >> > Am 05.06.2020 um 10:48 schrieb Gurkan Erdogdu <cgurkanerdo...@gmail.com >> >: >> > >> > Hi folks >> > I am reviewing the source code, but there are codes without comments in >> > many places. Please can you review the codes and write comments?I know >> this >> > is boring, but commenting is very important. Otherwise, it is not >> possible >> > to understand what is going on in your code. >> > Regards. >> > Gurkan >> >> > > -- > Gurkan Erdogdu > http://gurkanerdogdu.blogspot.com > -- Gurkan Erdogdu http://gurkanerdogdu.blogspot.com
