Re: [egit-dev] non javadoc comments

[Alex Blewitt <alex.blewitt@xxxxxxxxx>]

I made the comment under a "change as little as possible" type premise rather than thinking one way or another. The comment cleanup seemed to be orthogonal 

Sent from my (new) iPhone

On 19 Feb 2010, at 08:40, Wim Jongman <wim.jongman@xxxxxxxxx> wrote:

Hi,

I got a remark because, amongst other things, I removed non javadaoc comments. I removed them because they were not used consistently in the class (and because I don't like them). What is the preferred way of dealing with these comments?

See codestyles below:

Regards,

Wim

THIS (A):

projectsList.setContentProvider(new ITreeContentProvider() {

public Object[] getChildren(Object parentElement) {

}

public Object[] getElements(Object inputElement) {

}

                        /**

                         * Javadoc for new method

                         *

                         **/

public void newMethod(Object inputElement) {

}

OR THIS (B):

projectsList.setContentProvider(new ITreeContentProvider() {

/* (non-Javadoc)

* @see org.eclipse.jface.viewers.IContentProvider#inputChanged(org.eclipse.jface.viewers.Viewer, java.lang.Object, java.lang.Object)

*/

public void inputChanged(Viewer viewer, Object oldInput, Object newInput) {

}

/* (non-Javadoc)

* @see org.eclipse.jface.viewers.IContentProvider#dispose()

*/

public void dispose() {

}

/**

                         * Javadoc for new method

* @param inputElement

*/

public void newMetod(Object inputElement) {

}

_______________________________________________
egit-dev mailing list
egit-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/egit-dev