-
Notifications
You must be signed in to change notification settings - Fork 274
Update AV1500: Methods should not exceed 15 statements #359
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,39 @@ | ||
| --- | ||
| rule_id: 1500 | ||
| rule_category: maintainability | ||
| title: Methods should not exceed 7 statements | ||
| title: Methods should not exceed 15 statements | ||
| severity: 1 | ||
| --- | ||
| A method that requires more than 7 statements is simply doing too much or has too many responsibilities. It also requires the human mind to analyze the exact statements to understand what the code is doing. Break it down into multiple small and focused methods with self-explaining names, but make sure the high-level algorithm is still clear. | ||
| A method that requires more than 15 statements is simply doing too much or has too many responsibilities. It also requires the human mind to analyze the exact statements to understand what the code is doing. Break it down into multiple small and focused methods with self-explaining names, but make sure the high-level algorithm is still clear. | ||
|
|
||
| Also ensure that each method operates at a **single level of abstraction**. Mixing high-level functional calls (the "what") with low-level implementation details (the "how") in the same method makes it harder to understand the intent of the code. | ||
|
|
||
| ```csharp | ||
| // Avoid: mixing abstraction levels in the same method | ||
|
Comment on lines
+11
to
+12
|
||
| void ProcessOrder(Order order) | ||
| { | ||
| if (IsPremiumCustomer(order.CustomerId)) // functional; the "what" | ||
| { | ||
| ApplyDiscount(order); | ||
| } | ||
|
|
||
| if (Regex.IsMatch(order.Email.ToUpper().Trim(), @"^[^@]+@[^@]+\.[^@]+$")) // technical; the "how" | ||
|
|
||
| { | ||
| SendConfirmation(order.Email); | ||
| } | ||
| } | ||
|
|
||
| // Better: extract the technical detail behind an abstraction | ||
| void ProcessOrder(Order order) | ||
| { | ||
| if (IsPremiumCustomer(order.CustomerId)) | ||
| { | ||
| ApplyDiscount(order); | ||
| } | ||
|
|
||
| if (IsValidEmail(order.Email)) | ||
| { | ||
| SendConfirmation(order.Email); | ||
| } | ||
| } | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could additionally mention the concept of different abstraction levels, as described in Clean Code, if it isn't already covered by another rule. What I mean is that each method should have a single level of abstraction.
So not the code below in the same method: