[jira] [Created] (CASSANDRA-15895) Code comment with issue number

["ackelcn (Jira)" <ji...@apache.org>]

ackelcn created CASSANDRA-15895:
-----------------------------------

             Summary: Code comment with issue number
                 Key: CASSANDRA-15895
                 URL: https://issues.apache.org/jira/browse/CASSANDRA-15895
             Project: Cassandra
          Issue Type: Improvement
            Reporter: ackelcn


When I read the code of cassandra, I find some comments with issue numbers. One of them comes from JavaDriverClient.java:
{code:java}
public JavaDriverClient(StressSettings settings, String host, int port, EncryptionOptions encryptionOptions){
   ...
   //Always allow enough pending requests so every thread can have a request pending
    //See https://issues.apache.org/jira/browse/CASSANDRA-7217
    int requestsPerConnection = (maxThreadCount / connectionsPerHost) + connectionsPerHost;        
    maxPendingPerConnection = settings.mode.maxPendingPerConnection == null ? Math.max(128, requestsPerConnection ) : settings.mode.maxPendingPerConnection;
}{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/cassandrawithissuecomment] 

 

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)

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cassandra.apache.org
For additional commands, e-mail: commits-help@cassandra.apache.org