[
https://issues.apache.org/jira/browse/VXQUERY-94?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13661746#comment-13661746
]
Preston Carman commented on VXQUERY-94:
---------------------------------------
I briefly looked over your patch and have a few thoughts.
* Instead of putting comments on the same line as a piece of code. Add the
comment above the code so you can read it in a top to bottom fashion.
* Make sure each comment adds to the detail of the code. If you just commenting
to comment, that does not help but actually take away from the codes
readability.
* A couple of places you have a random * at the end of the comment. Is this on
purpose?
* Our source code does include any tabs. Please remove those in favor of
spaces, even in a comment.
> Add missing documentation comments in Apache VXquery-CLI
> --------------------------------------------------------
>
> Key: VXQUERY-94
> URL: https://issues.apache.org/jira/browse/VXQUERY-94
> Project: VXQuery
> Issue Type: Documentation
> Components: Infrastructure
> Reporter: Yasanka Sameera Horawalavithana
> Priority: Minor
> Labels: documentation
> Attachments: VXQUERY-94.samtube405.20130512.patch.txt
>
> Original Estimate: 24h
> Remaining Estimate: 24h
>
> Add missing documentation comments
> vxquery/vxquery-cli/src/main/java/org/apache/vxquery/cli/VXQuery.java
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
