AUTOMATICALLY EXPIRING OUT SOURCE CODE COMMENTS

• US 20170168816A1
• Filed: 06/09/2016
• Published: 06/15/2017
• Est. Priority Date: 12/14/2015
• Status: Active Grant

• Current Assignee: International Business Machines Corporation
• Original Assignee: International Business Machines Corporation
• Inventors: Dow, Eli M., Kohler, Rachel E., Martz, Kassidy, Woodlief, Christopher T.
• Granted Patent: US 9,760,368 B2
• Time in Patent Office: Days
• CPC Class Codes: G06F 8/73 Program documentation

Abstract

Aspects include a method for expiring out source code comments. The method includes parsing source code to locate one or more comments. The method also includes, for each of the located one or more comments: determining whether the comment specifies expiration criteria; determining whether the expiration criteria meets an expiration threshold based on the comment specifying expiration criteria; and deleting the comment from the source code based on determining that the expiration criteria meets the expiration threshold, the deleting resulting in updated source code. The method further includes storing the updated source code.

Claims

1. A method for expiring out source code comments, the method comprising:

determining, by an automated version control system, that a code build process that includes an edited source code has completed without errors;

performing, by a processor, based on determining that the code build process that includes the edited source code has completed without errors;

parsing the edited source code to locate one or more comments;

performing, for each of the one or more comments;

determining whether the comment specifies expiration criteria wherein the expiration criteria specifies a version number of the edited source code at the time that the comment was added;

based on the comment specifying expiration criteria;

determining whether the expiration criteria meets an expiration threshold, wherein the expiration threshold specifies that any comments added to the edited source code prior to a particular version number should be deleted; and

deleting the comment from the edited source code based on determining that the expiration criteria meets the expiration threshold, the deleting resulting in updated source code; and

storing the updated source code.

2. The method of claim 1, further comprising adding expiration criteria to at least one of the comments.

3. The method of claim 2, wherein the adding expiration criteria is performed by a processor in response to detecting that the at least one of the comments meets conversion criteria, the conversion criteria based on programming heuristics.

4. The method of claim 3, wherein the adding expiration criteria is further in response to a user confirming that the expiration criteria should be added.

5. The method of claim 2, wherein the adding expiration criteria to at least one of the comments is performed by a user.

6. The method of claim 2, wherein the adding expiration criteria is performed by a processor in response to detecting a placeholder in the comment for the expiration criteria.

8. The method of claim 1, wherein the expiration criteria further specifies an integrated development environment (IDE) phase in process at the time that the comment was added to the edited source code, and the expiration threshold further specifies that any comments added to the edited source code prior to a particular IDE phase should be deleted.

9. The method of claim 1, further comprising outputting a count of the number of comments that were deleted.

7. (canceled)