Skip to content

Commit

Permalink
Added a comment for @SuppressFBWarnings("DM_EXIT") (#623)
Browse files Browse the repository at this point in the history
* Added a comment for @SuppressFBWarnings("DM_EXIT")

* Updated comment for usage of @SuppressFBWarnings("DM_EXIT")
  • Loading branch information
sunidhi-prabhu committed Dec 11, 2023
1 parent 9451438 commit df7a71f
Showing 1 changed file with 8 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@

public class Main {
@SuppressFBWarnings("DM_EXIT")
/*
The @SuppressFBWarnings("DM_EXIT") annotation is added here to suppress FindBugs warnings concerning the direct use of System.exit().The value
"DM_EXIT" corresponds to the specific FindBugs detector for direct exit methods, indicating that this suppression is targeted at that particular
category of warnings. The justification for this suppression is that the usage of System.exit() in this code is intentional and serves a specific
purpose. Placing the justification and value directly in the annotation adheres to the common approach with SuppressFBWarnings, providing explicit
documentation about the deliberate decision to use System.exit() in the code.
*/

public static void main(String[] args) throws IOException {
CliOptions options = new CliOptions();
ParserProperties parserProperties = ParserProperties.defaults().withUsageWidth(150);
Expand Down

0 comments on commit df7a71f

Please sign in to comment.