[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
Re: [nebula-dev] Improve Source/Doc Quality in Nebula/Nebface with more restrictive settings
|
Hi Tom,
Yes I agree with you. We should hold ourselves to high standards.
Documentation is very important. Our project structure is in limbo at
the moment. We are going to be moving to a new structure where each
widget has its own java project. After we've completed this we should
look at this again. Applying more stringent compiler settings would be
a good move.
-Chris
Tom Schindl wrote:
Hi,
I'd suggest as a first step for your code review with Steve and others
to make your compiler setting more restrictive. As a good starting point
you can look at those of JFace. Only enabling the Javadoc errors gives
me 591 Errors in Javadoc (you don't only have to document public-methods
but at least also protected ones because they are part of your API)!
When I enable some of the Compiler-Settings the situation gets even
worse ;-)
I'd propose as a first step to make Javadoc-Errors and Compiler settings
marked in JFace as errors to be warnings and improve the situation. And
if all warnings are gone put them make errors out of them. I know it's
not the nicest task when programming but if you are forced to do this
when you work on code and it doesn't compile you will very fast start to
add them from the beginning. Without it think you'll never pass a code
review from the SWT-folks but I could be wrong though.
This is just an advice and I only wanted to make you aware of the
current situation but putting those settings to warning doesn't harm any
one.
Tom
_______________________________________________
nebula-dev mailing list
nebula-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/nebula-dev
