Skip to content

This repository was born out of an immersive journey through Robert C. Martin's seminal work, 'Clean Code.' It reflects my endeavor to translate the wisdom and guidelines from this transformative book into practical, executable Dart code.

License

Notifications You must be signed in to change notification settings

Yczar/dart-clean-code

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dart Clean Code Repository

Welcome to the Dart Clean Code Repository - a treasure trove for developers seeking to improve their coding skills and write more efficient, readable code.

This repository was born out of an immersive journey through Robert C. Martin's seminal work, 'Clean Code.' It reflects my endeavor to translate the wisdom and guidelines from this transformative book into practical, executable Dart code.

As a seasoned developer, my interaction with 'Clean Code' has fundamentally altered my perspective towards writing code, initiating a journey of continual learning and improvement. This repository serves as a testament to this journey and aims to guide others on a similar path.

Herein, you'll find Dart implementations of key concepts, principles, and patterns derived from 'Clean Code.' Whether you're a novice programmer or an experienced developer, these resources can help you elevate your coding skills, drive your understanding of 'clean' coding practices, and ultimately, make you a better Dart programmer.

Get ready to embark on an enlightening journey, refining your Dart coding practices, and contributing to cleaner, more efficient codebases. Let's dive in and start the journey towards mastering clean code in Dart!

Table of Contents

  1. Crafting Meaningful Names
  2. Creating Efficient Functions
  3. Perfecting Code Formatting
  4. Harnessing Objects and Data Structures
  5. Error Handling Mastery
  6. Understanding System Boundaries
  7. Demystifying Unit Tests
  8. Designing Effective Classes
  9. Building Robust Systems
  10. Unveiling the Power of Emergence
  11. Concurrency in Action
  12. Mastering Successive Refinement
  13. Detecting Code Smells and Heuristics
  14. State Management in Dart
  15. Miscellaneous

Let's dive in and start the journey towards mastering clean code in Dart!

Crafting Meaningful Names

The cornerstone of any great piece of code is the use of meaningful and descriptive names. These form the basis of understanding, the blueprint that allows developers to traverse the complex labyrinths of logic and functions without getting lost.

When crafting names for variables, functions, classes, and other programming constructs in Dart, it is essential to ensure they clearly express their intent. The name itself should tell us why it exists, what it does, and how it is used.

In this section, we delve into some critical guidelines to follow when naming entities in your Dart code:

  1. Use Intention-Revealing Names: Choose names that specify what a variable holds, a function does, or a class represents. The name itself should be a roadmap to understanding its purpose.

    // Bad
    int? d;  // elapsed time in days
    
    // Good
    int? elapsedTimeInDays;
  2. Avoid Disinformation: Stay clear of names that can be misleading or are ambiguous in the context of your code.

// Bad
int? lst; // Not clear what 'lst' stands for

// Good
int? listTotal;
  1. Make Meaningful Distinctions: Don't resort to number series (a1, a2, ...) or noise words (theProduct, myProduct, ...) for distinctions. Every name should have a purposeful and unique distinction.
// Bad
var product1 = Product();
var product2 = Product();

// Good
var smartphoneProduct = Product();
var tabletProduct = Product();
  1. Use Pronounceable and Searchable Names: If you can't pronounce it, you probably can't remember it. And if you can't search for it, you're in for a frustrating time.
// Bad
DateTime? genymdhms;

// Good
DateTime? generationTimestamp;

These structures should give a clear understanding of the importance of meaningful names in code. The examples should illustrate the points made, showing how these principles can be applied in real Dart code.

Creating Efficient Functions

Functions are the workhorses of any program. They provide the means to encapsulate actions, computations, or operations and use them again and again. They help us organize our code, make it more readable, and easier to maintain. In Dart, we need to ensure our functions are efficient, clear, and easy to use.

Here are some guidelines for creating efficient functions:

  1. Small Functions, Single Responsibility: Each function should do one thing and do it well. A function should be small, typically no more than a screen of code.

    // Bad example
    void processOrder(Order order) {
        validateOrder(order);
        calculateOrderTotal(order);
        applyDiscounts(order);
        arrangeShipping(order);
    }
    
    // Good example
    void processOrder(Order order) {
        validateOrder(order);
    }
    
    void calculateOrder(Order order) {
        calculateOrderTotal(order);
    }
    
    void applyOrderDiscounts(Order order) {
        applyDiscounts(order);
    }
    
    void arrangeOrderShipping(Order order) {
        arrangeShipping(order);
    }
  2. Descriptive Names: Function names should be clear about what the function does. A descriptive name makes it easier to understand what the function does without having to dive into the implementation details.

    // Bad example
    void p(Order order);
    
    // Good example
    void printInvoiceForOrder(Order order);
  3. Function Arguments: The ideal number of arguments for a function is zero. Next comes one, followed by two. Three arguments should be avoided where possible.

    // Bad example
    void createOrder(String id, String customerId, String itemId, int quantity, String shippingAddress);
    
    // Good example
    void createOrder(OrderCreationParameters parameters);

These are general good practices that can help make your code more manageable and understandable.

Perfecting Code Formatting

Proper code formatting is an often overlooked but essential aspect of software development. It's about making your code easier to read and understand for yourself, your teammates, and any future developers who might interact with your code. Good formatting practices in Dart consist of several elements:

  1. Indentation and Whitespace: Indentation is used to denote blocks of code. Consistent indentation and the use of whitespace enhance the readability of your code. Dart uses a two-space indent.

    // Good example
    if (isRaining) {
      bringUmbrella();
    } else {
      wearSunglasses();
    }
  2. Line Length and Wrapping: For Dart, the style guide suggests limiting your line length to 80 characters. Lines longer than that should be split into multiple lines.

    // Bad example
    String report = generateReport(reportName, reportData, true, DateTime.now(), "pdf", true, true);
    
    // Good example
    String report = generateReport(
      reportName,
      reportData,
      isFinal: true,
      date: DateTime.now(),
      format: "pdf",
      includeSummary: true,
      includeDetails: true,
    );
  3. Brace Style: Dart adopts the "K&R style" for braces. The opening brace goes on the same line as the start of the statement and the closing brace lines up with the start of the statement.

    // Good example
    for (var i = 0; i < 10; i++) {
      print(i);
    }
  4. Comments: Comments should be used sparingly and be up-to-date, clear, and concise. It's best to write code that explains itself.

    // Bad example
    // Subtracting ten
    var result = number - 10; 
    
    // Good example
    var discountPrice = price - discount; 

Remember, your code is more often read by humans (including your future self) than by machines. Maintain good formatting habits to keep your code understandable and manageable.

Harnessing Objects and Data Structures

Effectively managing and manipulating objects and data structures is a key aspect of programming. In Dart, there are many tools at your disposal to efficiently use objects and data structures. Let's dive into a few:

  1. Use Objects Appropriately: In Dart, every variable is an object, and every object is an instance of a class. The object-oriented nature of Dart allows you to encapsulate related data and functions into a single entity.

    // A simple Dart class
    class Vehicle {
      String model;
      int year;
    
      Vehicle(this.model, this.year);
    
      void printDetails() {
        print('Model: $model, Year: $year');
      }
    }
    
    var car = Vehicle('Toyota Corolla', 2020);
    car.printDetails(); // Prints: Model: Toyota Corolla, Year: 2020
  2. Choosing the Right Data Structure: Dart offers a range of data structures like Lists, Sets, and Maps. Understanding their properties and use-cases is essential to utilize them effectively.

    // Use a list when order matters
    List<String> fruits = ['apple', 'banana', 'cherry'];
    
    // Use a set when uniqueness is important
    Set<String> uniqueFruits = {'apple', 'banana', 'cherry', 'apple'}; // contains {'apple', 'banana', 'cherry'}
    
    // Use a map for key-value pairs
    Map<String, int> fruitPrices = {
      'apple': 1,
      'banana': 2,
      'cherry': 3,
    };
  3. Using Data Abstraction: Hide the implementation details and expose only the essential features of an object or a data structure. This can be achieved using encapsulation and getter/setter methods.

    class Circle {
      double _radius; // private instance variable
    
      Circle(this._radius);
    
      // getter method for circumference
      double get circumference => 2 * 3.1416 * _radius;
    
      // setter method for radius
      set radius(double radius) => _radius = radius >= 0 ? radius : 0;
    }

These practices can help improve the readability and maintainability of your code, making it easier to understand and modify as necessary.

Error Handling Mastery

Handling errors gracefully is critical to ensuring your applications function correctly and can recover from unexpected scenarios. In Dart, this can be accomplished through a variety of mechanisms including try/catch blocks, assertions, and error types.

  1. Try/Catch Blocks: These allow your code to attempt operations that may fail and handle any exceptions that may be thrown.

    try {
        var result = someFunctionThatMightThrow();
    } catch (e) {
        print('Caught an error: $e');
    }
  2. Throwing Errors: Dart allows you to throw custom exceptions, providing more control over error handling and making your code more descriptive.

    if (input < 0) {
        throw ArgumentError('Input cannot be negative');
    }
  3. Custom Error Types: Dart also allows you to define custom exception types to handle specific errors unique to your application's logic.

    class NegativeInputError extends Error {
        String toString() => 'Input cannot be negative';
    }
    
    if (input < 0) {
        throw NegativeInputError();
    }
  4. Finally Block: This block is executed regardless of whether an exception was thrown, and is typically used for cleanup code.

    try {
        var result = someFunctionThatMightThrow();
    } catch (e) {
        print('Caught an error: $e');
    } finally {
        print('Cleaning up...');
    }
  5. Assertions: They are useful during development for catching errors and exceptions as early as possible. An assertion disrupts normal execution if a boolean condition is false.

    int performCalculation(int input) {
        assert(input >= 0, 'Input cannot be negative');
        // Rest of the function...
    }

Mastering error handling in Dart can help ensure your applications are reliable, resilient, and easier to debug.

Understanding System Boundaries

Understanding and respecting system boundaries is fundamental to designing robust, maintainable software. These boundaries can exist between classes, modules, libraries, and even between different parts of the same function. In Dart, we can use a variety of techniques to define and work with these boundaries.

  1. Decoupling with Interfaces: Interfaces in Dart can be implicitly implemented, allowing for loose coupling between different parts of a system. This way, we can change the internal workings of a class without affecting its consumers.

    abstract class DataProvider {
        Future<List<String>> fetchData();
    }
    
    class NetworkDataProvider implements DataProvider {
        @override
        Future<List<String>> fetchData() {
            // Fetch data over the network...
        }
    }
    
    class DiskDataProvider implements DataProvider {
        @override
        Future<List<String>> fetchData() {
            // Fetch data from disk...
        }
    }
  2. Using Libraries to Encapsulate Code: Dart allows you to create libraries to encapsulate related code. This can provide clear boundaries and make your code easier to manage and understand.

    // in my_library.dart
    library my_library;
    
    part 'src/my_class.dart';
    part 'src/my_other_class.dart';
  3. Isolate for Concurrency: Dart's Isolate class can be used to run code on a different CPU core, effectively creating a boundary between it and the rest of your code.

    Isolate.spawn(myIsolateFunction, 'Hello from the main isolate');
  4. Boundaries in State Management: Understanding how state is shared and accessed across your system is crucial. Various state management techniques can help maintain clear boundaries, reducing complexity and potential bugs.

    // using Provider for state management
    Provider<CartModel>(
        create: (context) => CartModel(),
        child: MyApp(),
    );

By understanding and properly managing system boundaries, you can create code that's easier to test, maintain, and understand.

Demystifying Unit Tests

Unit tests are a vital part of developing robust and maintainable software. They help verify your code's correctness, make refactoring safer, and can even guide your design if you follow a test-driven development (TDD) approach. In Dart, we have a robust test package that facilitates writing unit tests.

  1. Writing Simple Unit Test: A simple test in Dart can be written using the test function. Assertions are made using the expect function.

    import 'package:test/test.dart';
    
    void main() {
        test('String.split() splits the string on the delimiter', () {
            var string = 'foo,bar,baz';
            expect(string.split(','), equals(['foo', 'bar', 'baz']));
        });
    }
  2. Grouping Tests: Tests can be grouped together using the group function. This makes tests easier to manage and read.

    import 'package:test/test.dart';
    
    void main() {
        group('String.split()', () {
            test('splits the string on the delimiter', () {
                var string = 'foo,bar,baz';
                expect(string.split(','), equals(['foo', 'bar', 'baz']));
            });
    
            test('returns the string if no delimiter is present', () {
                var string = 'foobar';
                expect(string.split(','), equals(['foobar']));
            });
        });
    }
  3. Mocking and Stubbing: For more complex unit tests, you might need to stub or mock certain behaviors. The mockito package is a popular choice for this in Dart.

    import 'package:mockito/mockito.dart';
    import 'package:test/test.dart';
    
    class MockFoo extends Mock implements Foo {}
    
    void main() {
        test('Mocking example', () {
            var mockFoo = MockFoo();
            when(mockFoo.someMethod('valid input')).thenReturn('expected output');
            expect(mockFoo.someMethod('valid input'), equals('expected output'));
        });
    }

Remember, unit tests are your friends. They can save you from future headaches by catching bugs early in the development process. They can also serve as a form of documentation, showcasing how your code is supposed to work.

Designing Effective Classes

Designing effective classes is a fundamental aspect of object-oriented programming (OOP). In Dart, classes provide a means to encapsulate data and methods that work on that data. A well-designed class can be reused in various contexts, making your code more efficient and maintainable.

  1. Creating a Basic Class: In Dart, a class can be created using the class keyword.

    class Animal {
        String name;
    
        Animal(this.name);
    
        void makeSound() {
            print('$name makes a sound');
        }
    }
  2. Inheritance and Method Overriding: Dart supports single inheritance. Subclasses can override the methods of the superclass.

    class Dog extends Animal {
        Dog(String name): super(name);
    
        @override
        void makeSound() {
            print('$name barks');
        }
    }
  3. Implementing Interfaces: Dart classes can implement one or more interfaces. This enforces a contract of methods that the class must define.

    class Cat extends Animal implements Playful {
        Cat(String name): super(name);
    
        @override
        void makeSound() {
            print('$name meows');
        }
    
        @override
        void play() {
            print('$name plays with a ball of yarn');
        }
    }
  4. Creating Private Members: In Dart, class members (both fields and methods) can be made private by prefixing their name with an underscore.

    class Secretive {
        String _privateField;
    
        void _privateMethod() {
            // ...
        }
    }

Designing effective classes involves more than just understanding these basic concepts. It requires careful thought and planning to create classes that are easy to understand, flexible, and efficient. Remember the principles of SOLID design and strive to create classes that have a single responsibility, are open for extension but closed for modification, and have clearly defined interfaces.

Building Robust Systems

Building robust systems is a core responsibility of every developer. Robust systems are characterized by their ability to handle unexpected conditions gracefully, maintain performance under stress, and recover quickly from failures. In Dart, there are several practices that can contribute to system robustness.

  1. Effective Error Handling: We've already discussed error handling in depth. Consistent, effective error handling is a cornerstone of a robust system.

    try {
        performRiskyOperation();
    } catch (e) {
        // Log and handle error
    }
  2. Concurrency and Asynchronicity: Dart's Future and async/await syntax allow for easy management of asynchronous operations. Asynchronous programming can greatly improve system performance and responsiveness.

    Future<void> loadData() async {
        // Async operation
    }
  3. State Management: Managing the state of your application effectively can reduce bugs and improve performance. Various approaches can be adopted, such as the BLoC pattern.

    class CounterBloc extends Bloc<CounterEvent, int> {
        @override
        int get initialState => 0;
    
        @override
        Stream<int> mapEventToState(CounterEvent event) async* {
            // Map CounterEvent to appropriate state
        }
    }
  4. Unit and Integration Testing: Tests ensure that your system behaves as expected and help catch regressions. Dart provides a strong testing library for both unit and integration tests.

    void main() {
        test('description', () {
            // Test case
        });
    }
  5. Code Reviews and Pair Programming: These practices provide another set of eyes to catch issues and provide feedback, making your code more robust and maintainable.

Remember that building robust systems is not just about writing good code, but also about following best practices, continuously learning and refining your approach, and understanding and fulfilling the requirements of your users.

Unveiling the Power of Emergence

Emergence in the context of software engineering refers to the phenomenon where simple rules or behaviors at the lower level can lead to complex and sophisticated behaviors at the higher level. When we structure our code well, maintain good practices and follow established principles, we enable emergence - our codebase starts to exhibit behaviors that are greater than the sum of its parts.

  1. Run All Tests: Ensuring that all unit tests are passing at all times is a simple practice that greatly contributes to emergence. It ensures that new changes don't break existing functionality.

    // Example of a basic test in Dart
    import 'package:test/test.dart';
    
    void main() {
      test('my first unit test', () {
        var answer = 42;
        expect(answer, 42);
      });
    }
  2. Refactor Code: Continually refactoring and improving the structure of your code leads to a more manageable and understandable codebase.

    // Before refactoring
    var a = 3;
    var b = 4;
    var c = a * a + b * b;
    print(c);  // prints 25
    
    // After refactoring
    int calculateHypotenuse(int a, int b) {
      return a * a + b * b;
    }
    print(calculateHypotenuse(3, 4));  // prints 25
  3. Expressive and Consistent Naming: Using expressive and consistent names for variables, functions, classes, etc. can significantly improve the readability of your code, facilitating better understanding and cooperation among team members.

    // Before: Not very expressive
    var p = getPerimeter(3, 4);
    
    // After: Much more expressive
    var rectanglePerimeter = calculateRectanglePerimeter(3, 4);

The power of emergence isn't about doing one big thing right, but doing many small things right. When you start applying these principles, over time, you will see your codebase becoming more maintainable, scalable, and robust.

Concurrency in Action

Concurrency in programming refers to the ability of a system to handle multiple tasks at once. In a concurrent system, several computations are executing simultaneously and potentially interacting with each other. Understanding and managing concurrency in Dart can greatly improve the responsiveness and performance of your applications.

  1. Understanding Future and async/await: Dart makes handling concurrency easier with the use of Future objects and async/await syntax.

    // A function that returns a Future that produces a string
    Future<String> fetchUserOrder() {
        return Future.delayed(Duration(seconds: 2), () => 'Cappuccino');
    }
    
    // Using async/await to wait for the Future to complete
    void main() async {
        print('Fetching user order...');
        var order = await fetchUserOrder();
        print('Your order is: $order');
    }
  2. Leveraging Stream: A Stream in Dart is a sequence of asynchronous events. It's a way of getting data piece by piece, instead of getting it all at once.

    // A function that produces a Stream
    Stream<int> countStream(int to) async* {
        for (int i = 1; i <= to; i++) {
            await Future.delayed(Duration(seconds: 1));
            yield i;
        }
    }
    
    // Consuming a Stream using an async for-loop
    void main() async {
        await for (var count in countStream(5)) {
            print('Count: $count');
        }
    }

Concurrency is a challenging concept, but with the right tools and understanding, you can write code that handles multiple tasks simultaneously, making your applications more efficient and responsive.

Mastering Successive Refinement

Successive Refinement is the practice of continuously refining and improving your code over time. It's the process of revisiting code written earlier, understanding it, and making improvements while maintaining functionality.

  1. Continual Improvement: Write the first draft of your code to work, then refine it to make it cleaner and efficient. Code refinement should be a continuous process.

    // First Draft
    bool isPrime(int n) {
        if (n <= 1) {
            return false;
        }
        for (int i = 2; i < n; i++) {
            if (n % i == 0) {
                return false;
            }
        }
        return true;
    }
    
    // Improved Version
    bool isPrime(int n) {
        if (n <= 1) return false;
        if (n == 2) return true;
        if (n % 2 == 0) return false;
        for (int i = 3; i * i <= n; i += 2) {
            if (n % i == 0) return false;
        }
        return true;
    }
  2. Keep the Code DRY: 'DRY' stands for 'Don't Repeat Yourself.' If you find yourself writing the same code more than twice, consider creating a function or class to encapsulate that functionality.

    // Repeated Code
    print('Fetching data...');
    var data = await fetchData();
    print('Data fetched.');
    
    print('Fetching more data...');
    var moreData = await fetchMoreData();
    print('More data fetched.');
    
    // DRY Code
    Future<T> fetchDataWithLog<T>(Future<T> Function() fetchFunction) async {
        print('Fetching data...');
        var data = await fetchFunction();
        print('Data fetched.');
        return data;
    }
    
    void main() async {
        var data = await fetchDataWithLog(fetchData);
        var moreData = await fetchDataWithLog(fetchMoreData);
    }

Remember, the goal of successive refinement isn't to write perfect code from the get-go. Instead, it's about recognizing that your understanding and the quality of your code will improve over time.

Detecting Code Smells and Heuristics

Code smells are indicators in the code that suggest a problem that needs attention. These are not bugs, but rather symptoms of poor design or implementation choices. Heuristics, on the other hand, are experienced-based techniques for problem-solving, learning, and discovery.

Here are a few examples:

  1. Duplicate Code: If the same code structure is found in more than one place, it might be a good idea to encapsulate it in a single function or class.

    // Duplicate Code
    void printStudentDetails(Student s) {
        print('Name: ${s.name}');
        print('Age: ${s.age}');
        print('Grade: ${s.grade}');
    }
    
    void printTeacherDetails(Teacher t) {
        print('Name: ${t.name}');
        print('Age: ${t.age}');
        print('Subject: ${t.subject}');
    }
    
    // Refactored Code
    void printPersonDetails(Person p, String additionalInfo) {
        print('Name: ${p.name}');
        print('Age: ${p.age}');
        print(additionalInfo);
    }
  2. Long Function or Class: A function or class that has grown too large is hard to understand and maintain. Consider breaking it down into smaller, more manageable pieces.

    // Long Function
    void doEverything() {
        // hundreds of lines of code...
    }
    
    // Refactored Code
    void doPart1() { /* ... */ }
    void doPart2() { /* ... */ }
    void doPart3() { /* ... */ }
    
    void doEverything() {
        doPart1();
        doPart2();
        doPart3();
    }
  3. Comments explaining complex code: If you need a comment to explain what a bit of code does, it might be a sign that the code is too complex. Consider refactoring it to make its purpose clearer.

    // Complex Code
    void calculate() {
        // Complex calculations...
    }
    
    // Refactored Code
    void calculate() {
        prepareData();
        performCalculations();
        storeResults();
    }

Detecting these code smells and others can help you keep your code clean and maintainable. Remember, these are heuristics, not hard and fast rules. Use your judgment and experience to determine when and how to apply them.

State Management in Dart

State Management is a crucial aspect of any application. In Dart, and specifically Flutter, there are various ways to handle state management. It determines how we store and share data across our application, affecting the app's performance and usability.

Here's a quick overview of some common state management techniques in Dart:

  1. Provider: Provider is a dependency injection system built with widgets for widgets. It mixes dependency injection (DI) and state management to ensure objects consume dependencies without requiring the manual passing of a reference from one widget to another.

    // Provider example
    void main() {
      runApp(
        ChangeNotifierProvider(
          create: (context) => CounterModel(),
          child: MyApp(),
        ),
      );
    }
    
    class CounterModel with ChangeNotifier {
      int _count = 0;
      int get count => _count;
    
      void increment() {
        _count++;
        notifyListeners();
      }
    }
  2. Riverpod: Riverpod is a robust way to handle state management. It overcomes some of the limitations of Provider, such as allowing providers to be consumed anywhere without context and offering an improved mechanism to deal with Flutter's widget lifecycle.

    // Riverpod example
    final counterProvider = StateProvider<int>((ref) => 0);
    
    class Counter extends ConsumerWidget {
      @override
      Widget build(BuildContext context, WidgetRef ref) {
        final count = ref.watch(counterProvider);
        return Text('$count');
      }
    }
  3. Redux: Redux is a predictable state container that helps to write applications that behave consistently across different environments (client, server, and native).

    // Redux example
    // Defining the State
    class AppState {
      final int count;
      AppState({this.count = 0});
    }
    
    // Reducer
    AppState reducer(AppState state, dynamic action) {
      if (action == Actions.Increment) {
        return AppState(count: state.count + 1);
      } else {
        return state;
      }
    }
    
    // Store
    final store = Store<AppState>(reducer, initialState: AppState());

Remember, choosing a state management strategy depends on your project's complexity, size, and your team's familiarity with the pattern. Strive for consistency, predictability, and understandability when making your choice.

Miscellaneous

In this section, we tackle a variety of additional topics that don't neatly fit into our previous categories, yet remain crucial in the pursuit of clean code. This includes areas such as security considerations, optimization techniques, and maintaining code agility as projects scale.

First up, let's delve into Class Modifiers within the scope of Clean Code principles:

Exploring Class Modifiers in Clean Code

In Dart, class modifiers control the usage of a class or mixin within its own library and beyond. The set of modifiers include:

  • abstract
  • base
  • final
  • interface
  • sealed
  • mixin

They precede a class or mixin declaration and influence the expected behaviours of the class.

Consider the following examples illustrating their usage:

// 'abstract' modifier
abstract class AbstractEntity {
  void save();
}

// 'base' modifier
base class User extends AbstractEntity {
  String name;
  
  @override
  void save() {
    // Implementation for saving a user
  }
}

// 'final' modifier
final class Admin extends User {
  @override
  void save() {
    // Implementation for saving an admin
  }
}

Class modifiers are invaluable tools for managing class behaviors and safeguarding the integrity of your codebase. A sound understanding and correct application of these modifiers is a key aspect of writing clean, maintainable code.

For a comprehensive study of these class modifiers, please refer to the Dart documentation here.

Conclusion

Mastering the art of clean, efficient, and maintainable code is an ongoing journey. We've covered a range of topics in this repository from creating meaningful names and crafting efficient functions, to understanding system boundaries and mastering successive refinement, and even touched upon important topics like state management in Dart.

We've also explored the fascinating world of class modifiers in Dart, shedding light on abstract, base, final, interface, sealed, and mixin.

This is just a stepping stone in your path to becoming a better Dart developer. As you continue to grow and learn, remember to keep refining and polishing your skills. Programming is a craft, and like any craftsperson, you should take pride in your work.

Your code is a reflection of your understanding and your thought process. Make it count. It's not just about making your code work, it's about crafting a piece of art that stands the test of time. Happy coding!

Remember, there's no endpoint to learning in this field. So, stay curious, keep exploring, and most importantly, enjoy the process!

Contributing

We appreciate all contributions to our project! If you're interested in contributing, please refer to our CONTRIBUTING.md file. It provides a detailed guide on how to get started with contributing to our codebase. We look forward to your suggestions, bug reports, and pull requests.

About

This repository was born out of an immersive journey through Robert C. Martin's seminal work, 'Clean Code.' It reflects my endeavor to translate the wisdom and guidelines from this transformative book into practical, executable Dart code.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages