[jboss-jira] [JBoss JIRA] Updated: (JBAS-6994) Improve developer javadoc

[Thomas Diesler (JIRA)]

     [ https://jira.jboss.org/jira/browse/JBAS-6994?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Thomas Diesler updated JBAS-6994:
---------------------------------

    Description: 
Jason sais

The javadoc/code comments in our core modules are VERY lacking, so it is incredibly difficult for new folks to understand how anything is supposed to work (I have been hearing some groaning about this recently).

All of our code, especially SPI or API classes must have javadoc which explains in detail the following things:

1) How the module is supposed to be used (and how it is actually used if known)
2) The intended behavior, and any aspect of it that is known to be broken or a hack (so that someone can differentiate between a design problem and just an unimplemented section that needs to be fixed)
3) Crticial preconditions (e.g. "this class expects that the same vfs handle instance be reused during a redeploy")
4) Thread-access design (e.g. "this class is thread-safe and can be accessed from multiple threads", "this class is not thread-safe, and all callers must use a shared lock to access", "this class is intended to have an instance-per-thread")

If we can't answer these simple questions, then it is likely our design is flawed.



> Improve developer javadoc
> -------------------------
>
>                 Key: JBAS-6994
>                 URL: https://jira.jboss.org/jira/browse/JBAS-6994
>             Project: JBoss Application Server
>          Issue Type: Task
>      Security Level: Public(Everyone can see) 
>          Components: Other
>            Reporter: Thomas Diesler
>             Fix For: JBossAS-6.0.0.Alpha1
>
>
> Jason sais
> The javadoc/code comments in our core modules are VERY lacking, so it is incredibly difficult for new folks to understand how anything is supposed to work (I have been hearing some groaning about this recently).
> All of our code, especially SPI or API classes must have javadoc which explains in detail the following things:
> 1) How the module is supposed to be used (and how it is actually used if known)
> 2) The intended behavior, and any aspect of it that is known to be broken or a hack (so that someone can differentiate between a design problem and just an unimplemented section that needs to be fixed)
> 3) Crticial preconditions (e.g. "this class expects that the same vfs handle instance be reused during a redeploy")
> 4) Thread-access design (e.g. "this class is thread-safe and can be accessed from multiple threads", "this class is not thread-safe, and all callers must use a shared lock to access", "this class is intended to have an instance-per-thread")
> If we can't answer these simple questions, then it is likely our design is flawed.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira