cschneider commented on pull request #109: URL: https://github.com/apache/aries/pull/109#issuecomment-648634910
`When you click a code line, it then presents a window to show the issue reports and commits.` Yes. It could work like this. `I agree that some comments may describe too simple code lines, but shall we still accept comments on those complicated ones?` I think it is like with comments in general. You put them were you think that additional explanations are required to understand the code. At the same time every comment is a liability. Comments tend to rott as they are not tested by junit. So over time a comment might describe something that is not matching the changed code anymore at all. This is why I favour improving the code instead of adding many comments. Jiras can be used to track and explain the requirements. So sometimes links to them make sense. Unfortunately they do not track the changes over time. So possibly a jira represents a requirement at some point in time but later the requirement might have vanished or changed. The old jira issue will not reflect this. So adding the link is easy and can be automated as you demonstrate with your tool. Managing the link over time is much harder. This is why I think adding the links on the fly while viewing from the blame feature is better. When the code is changed because of changed requirements then the on the fly tool will automatically change to the new jiras. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
