About classloader proxy: suspect I can need a more precise request - sadly I wrote this class so I understand it :s. But the only thing in this whole class is putting a proxy class in a map in https://github.com/apache/openwebbeans/blob/master/webbeans-impl/src/main/java/org/apache/webbeans/service/ClassLoaderProxyService.java#L135. Not sure we need a comment thanks to the class name, or does the name miss "ClassDefiningService" explicitly?
About spring: I hate this kind of codebase, you take way more time to try to read the comment than the code source and I never got luck I assume cause when I spend 5mn on the doc I always end up reading the code which takes way less time. Writing so much javadoc makes sense when you use the code as an API - our SPI is into this category and we should explain the expectations and requirements - but impl is not in that category at all. If an user uses owb-impl in his project there is an issue. Since we don't publish our impl modules javadoc I think it is saner to keep the comments for not obvious explanations - for ex https://github.com/apache/openwebbeans/blob/master/webbeans-impl/src/main/java/org/apache/webbeans/config/BeansDeployer.java#L1424 . Hope it explains a bit where I'm coming from and what I'm hoping we target. Le ven. 5 juin 2020 à 15:21, Gurkan Erdogdu <cgurkanerdo...@gmail.com> a écrit : > 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 >
