Hi Patrik,
Great! I am so glad to know that there is a way to document the model and
have it be generated as javadoc. This is good enough for me. I can modify
the template to get what I need. And I agree that the Checkstyle rule is
kind of a pain. It's useful about half the time. :)
Thanks!
--Polly
Patrik Nordwall wrote:
>
> Thanks for your positive feedback.
>
> Documentation can be added to most elements in model.design using quoted
> string above it, like this:
> "This class is responsible..."
> Entity Planet {
> "The name of the planet..."
> String name
> }
>
> JavaDoc based on this documentation is generated. For attributes it is
> generated in the getter-methods, not at the private field declaration.
>
> Is that ok for you?
>
> My opinion:
> I would never use a checkstyle rule that complains about missing JavaDoc
> for private fields.
> I wouldn't even use checkstyle rule that complains at the method level
> either. If you use good naming you don't need JavaDoc for most of the
> methods. If you make it mandatory it will only be trivial documentation to
> satisfy the rule, which will be a maintenance burden.
>
> /Patrik
>
>
>
>
--
View this message in context:
http://www.nabble.com/-Sculptor--Generate-javadoc-for-attributes--tp18101114s17564p18114646.html
Sent from the Fornax-Platform mailing list archive at Nabble.com.
-------------------------------------------------------------------------
Check out the new SourceForge.net Marketplace.
It's the best place to buy or sell services for
just about anything Open Source.
http://sourceforge.net/services/buy/index.php
_______________________________________________
Fornax-developer mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/fornax-developer
