Skip to content

Banners, dividers, closing-brace comments, emoji decoration ​

Comments and text: one of the ways AI coding agents bloat software, from lessloc's pattern catalog. lessloc catches it as narration.

What makes banners, dividers, closing-brace comments, emoji decoration a bad practice? ​

The standard that calls it a bad practice: Clean Code: Position Markers, Closing Brace Comments.

What does lessloc do about banners, dividers, closing-brace comments, emoji decoration? ​

lessloc catches it as narration.

  • narration (tier 3): Comments that narrate the code, decorate it or restate a name, closing-brace comments, and log lines that narrate each step.

Examples ​

Caught as narration:

python
# ========== Helpers ==========
def a():
    return 1

Written well:

python
# Rates are cached for a minute: the provider bills per call
def a():
    return 1

Caught as narration:

js
function a() {
  return 1;
} // end function

Written well:

js
function a() {
  return 1;
}

The other patterns in Comments and text:

Released under the Apache-2.0 license. · llms.txt