Monthly Shaarli

All links of one month in a single page.

January, 2022

What is the meaning of #XXX in code comments? - Stack Overflow
thumbnail
  • NOTE: Description of how the code works (when it isn't self evident).
  • XXX: Warning about possible pitfalls, can be used as NOTE:XXX:.
  • HACK: Not very well written or malformed code to circumvent a problem/bug. Should be used as HACK:FIXME:.
  • FIXME: This works, sort of, but it could be done better. (usually code written in a hurry that needs rewriting).
  • BUG: There is a problem here.
  • TODO: No problem, but additional code needs to be written, usually when you are skipping something.

At least this is how I was taught about these tags. Basically the first two (NOTE and XXX) are used for information and no action is required. While the last three (FIXME, BUG and TODO) do require action. HACK is somewhere in between (and hardly ever used I think?).

GitHub - Zhtwn/Vitruvius: Perl tools for code architects
thumbnail

Vitruvius is a framework and set of tools to help the code architect analyze a code base.

https://mtlynch.io/human-code-reviews-1/
thumbnail
DevIQ
thumbnail

DevIQ is a reference site designed to help you learn about high-level software development topics like domain driven design, design patterns, and antipatterns.