[
https://issues.apache.org/jira/browse/CALCITE-4137?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17165124#comment-17165124
]
Julian Hyde commented on CALCITE-4137:
--------------------------------------
Javadoc is not just for documenting public APIs. In Calcite it is the main
design documentation.
So yes, I think we should require javadoc for all classes. It gets people to
write down their intent -- not just what this component is and does, but why it
is necessary -- so it acts as a forcing function for what good developers would
be doing anyway.
We don't require javadoc for methods or fields -- though public and protected
fields and methods *should* have javadoc -- so the burden is not too onerous.
> Checkstyle should ensure that every class has a Javadoc comment
> ---------------------------------------------------------------
>
> Key: CALCITE-4137
> URL: https://issues.apache.org/jira/browse/CALCITE-4137
> Project: Calcite
> Issue Type: Bug
> Reporter: Julian Hyde
> Assignee: Julian Hyde
> Priority: Major
> Fix For: 1.25.0
>
>
> Checkstyle should ensure that every class, interface, enum, package has a
> Javadoc comment. And that javadoc types (e.g {{@param}} and {{@return}}) are
> not empty.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
