alibaba / dubbo-spring-boot-starter

Dubbo Spring Boot Starter
Apache License 2.0
2.1k stars 745 forks source link

Avoid use of Javadoc tag for configuration key descriptions #114

Open snicoll opened 5 years ago

snicoll commented 5 years ago

The current DubboProperties uses Javadoc tags (such as {@link}) in field descriptions. The annotation processor doesn't clean those and write the description as is in the metadata. This is not recommended as described in the documentation:

You should only use simple text with @ConfigurationProperties field Javadoc, since they are not processed before being added to the JSON.

Please clean those. More generally, using an IDE and acting as a user to check if the property name and description makes sense is always best.