Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[egit-dev] non javadoc comments

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) {
}



Back to the top