10 Matching Annotations
  1. Feb 2025
    1. what's more important from the perspective of a software architect is why a particular implementation or approach was chosen over its alternatives. A common way to document decisions like this is to use architecture decision records, ideally stored in source control with or near the application(s) impacted by the decision.
  2. Sep 2022
    1. Good code is its own best documentation. As you’re about to add a comment, ask yourself, "How can I improve the code so that this comment isn’t needed?". Improve the code and then document it to make it even clearer.
  3. Mar 2021
    1. The absence of a method name here is per design: this object does only one thing, and hence what it does is reflected in the class name.
  4. Feb 2021
  5. Nov 2020
    1. One last bonus: CSS variables can be written in a way that makes it easier for human programmers to understand. If you just see hex code #93e9be, you won’t know what color it produces, while --brand-green makes clear the purpose of the variable.
  6. Jul 2020
  7. Nov 2019
    1. There's no technical reason why you couldn't detect enum columns at startup time and automatically do this wireup, but I feel that the benefit of self-documenting outweighs the convenience.