[CASSANDRA-16096] Change style guide to include @Override

• Type: Improvement
• Status: Resolved
• Priority: Low
• Resolution: Fixed
• Fix Version/s: 4.0-beta3, 4.0
• Component/s: Build, Documentation/Website
• Change Category: Code Clarity
• Complexity: Low Hanging Fruit
• Platform: All

Source Control Link

https://github.com/apache/cassandra/commit/614d7d06f4964f03681e9e90d98ddf3562c47598

Test and Documentation Plan

deleted project in IntelliJ, ran ant realclean && ant && ant generate-idea-files, then created class based off interface and saw autogenerated methods included @Override

• Assignee: David Capwell
• Reporter: David Capwell

Authors

David Capwell

Reviewers

David Capwell

• Created: 02/Sep/20 17:40
• Updated: 03/Jan/21 17:03
• Resolved: 02/Sep/20 18:37

Description

@Override is used by javac to enforce that a method is in fact overriding from an abstract class or an interface and if this stops being true (such as a refactor happens) then a compiler error is thrown; when we default to excluding, it makes it harder to detect that a refactor catches all implementations and can lead to subtle and hard to track down bugs.

This ticket removes the comment in the docs that @Override should be avoided and updated the style guide to include them by default.

Issue Links

• links to: GitHub branch: trunk