New Codesytel guidlines and some questions
Hi all, at the moment I am working on xml-rpc in xwiki, I am adding documentation and fix the coding style. But I run in some trouble: 1) I have an interface "ConfluenceRpcInterface", which is documentet quite well. Now in "ConfluenceRpcHandler", which implements the "ConfluenceRpcInterface" I need to add javadoc to each method. The question now: Shall I copy and paste the javadoc from the interface, is it okay to add something like /* * (non-Javadoc) * @see com.xpn.xwiki.xmlrpc.ConfluenceRpcInterface#login(java.lang.String, java.lang.String) */ or should I not document the interface and add the documentation to the implemantion of the interface? 2) ArrayList is not allowed. What should I use instead? Thanks, austriancoder
Hi Christian, On Feb 16, 2007, at 4:22 PM, Christian Gmeiner wrote:
Hi all,
at the moment I am working on xml-rpc in xwiki, I am adding documentation and fix the coding style. But I run in some trouble:
1)
I have an interface "ConfluenceRpcInterface", which is documentet quite well. Now in "ConfluenceRpcHandler", which implements the "ConfluenceRpcInterface" I need to add javadoc to each method. The question now: Shall I copy and paste the javadoc from the interface, is it okay to add something like
/* * (non-Javadoc) * @see com.xpn.xwiki.xmlrpc.ConfluenceRpcInterface#login (java.lang.String, java.lang.String) */
or should I not document the interface and add the documentation to the implemantion of the interface?
Thanks for asking. I've updated the following doc with the information: http://www.xwiki.org/xwiki/bin/view/Community/CodeStyle
2) ArrayList is not allowed. What should I use instead?
ArrayList is not allowed as a return type as return types must be interfaces and not classes. So try List instead. Thanks -Vincent
participants (2)
-
Christian Gmeiner -
Vincent Massol