Reducing duplication
Jonathan Gibbons
jonathan.gibbons at oracle.com
Fri Sep 13 20:50:02 UTC 2024
Re:
https://mail.openjdk.org/pipermail/core-libs-dev/2024-September/129508.html
This is a thread on using increasing the use of `{@return}`
In it, Pavel wrote:
> Maybe if a method's main description consisted only of `{@return}`, we could skip the first sentence in the "Method Details" section and just output `Returns:`? Any further discussion should happen on the javadoc-dev mailing list.
I think this is a good idea to look at. Although it does not have as
catchy an acronym, "Don't Repeat Yourself" (DRY) could be extended to
"Don't Make Me Read The Same text Twice" (DMMRTSTT).
-- Jon
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.org/pipermail/javadoc-dev/attachments/20240913/62281538/attachment-0001.htm>
More information about the javadoc-dev
mailing list