ackelcn commented on CARBONDATA-3866:



This pull request highlights the new comments. 

> Code comment with issue numbers
> -------------------------------
>                 Key: CARBONDATA-3866
>                 URL: https://issues.apache.org/jira/browse/CARBONDATA-3866
>             Project: CarbonData
>          Issue Type: Improvement
>            Reporter: ackelcn
>            Priority: Major
> When I read the code of carbondata, I find several comments with issue 
> numbers. One of them comes from CSVCarbonWriterTest.java:
> {code:java}
>  // [CARBONDATA-3688]: compressor name is added in data file name 
> @Test public void testFileName() throws IOException { 
>   String path = "./testWriteFiles"; 
>   FileUtils.deleteDirectory(new File(path)); 
>   Field[] fields = new Field[2]; 
>   fields[0] = new Field("name", DataTypes.STRING); 
>   fields[1] = new Field("age", DataTypes.INT); 
>   TestUtil.writeFilesAndVerify(new Schema(fields), path);
> ...
> }{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/carbondatawithissuecomment] 
> 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

Reply via email to