[
https://issues.apache.org/jira/browse/UIMA-6248?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17143526#comment-17143526
]
ackelcn commented on UIMA-6248:
-------------------------------
Many thanks for your feedbacks. My tool compares the latest code with the
commits, and it ensures that the updated code still appears in the latest
files, before it comments a code.
With Eclipse, I can check the history of a file, but I cannot see the links
between a code line to a commit. As a result, when I have problems in
understanding a code line, I have to manually check many commits to locate the
one that modified the line.
My tool recovers the links. Is that useful?
> Code comment with issue number
> ------------------------------
>
> Key: UIMA-6248
> URL: https://issues.apache.org/jira/browse/UIMA-6248
> Project: UIMA
> Issue Type: Improvement
> Reporter: ackelcn
> Priority: Major
>
> When I read the code of uimaj, I find some comments with issue numbers. One
> of them comes from OperationalProperties_impl.java:
> {code:java}
> // overridden to set proper defaults
> // https://issues.apache.org/jira/browse/UIMA-2350
> // These change depending on the element which is the parent of the
> parent of this element
> String grandParentName = "";
> Node p = aElement.getParentNode();
> if (p instanceof Element) {
> Node gp = p.getParentNode();
> if (gp instanceof Element) {
> grandParentName = ((Element) gp).getTagName();
> }
> }
> setModifiesCas(grandParentName.equals("casConsumerDescription") ? false :
> true);{code}
> These comments are quite useful for other programmers and me to understand
> the code, but I notice that not all issue numbers are written in code
> comments. It can be already quite tedious to write them into commit messages
> :)
>
> To handle the problem, I implemented a tool to automatically instrument issue
> numbers into code comments. I tried my tool on activemq, and the instrumented
> version is [https://github.com/ackelcn/uima-uimaj]
>
> To avoid confusion, if there is already an issue number in code comments, my
> tool ignored the issue number. All my generated comments start from //IC, so
> it is easy to find them.
>
> Would you please some feedbacks to my tool? Please feel free to merge my
> generated comments in your code, if you feel that some are useful.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
