[{"data":1,"prerenderedAt":275},["ShallowReactive",2],{"rule-/rules/no-excessive-comments":3},{"id":4,"title":5,"body":6,"category":263,"description":15,"extension":264,"isWrapped":265,"meta":266,"navigation":267,"path":268,"ruleType":269,"seo":270,"stem":271,"tier":272,"upstreamUrl":273,"__hash__":274},"rules/rules/no-excessive-comments.md","no-excessive-comments",{"type":7,"value":8,"toc":257},"minimark",[9,12,16,27,32,35,39,93,97,120,124,127,246,253],[10,11,5],"h1",{"id":5},[13,14,15],"p",{},"Disallow functions where comment-to-code ratio exceeds a threshold",[13,17,18,22,23,26],{},[19,20,21],"strong",{},"Category:"," Boilerplate Bloat | ",[19,24,25],{},"Tier:"," Pro",[28,29,31],"h2",{"id":30},"why-this-matters","Why This Matters",[13,33,34],{},"AI loves to narrate every line of code. These comments restate what the code already says, adding visual noise without insight. They make files harder to scan and create maintenance burden when the code changes but comments do not.",[28,36,38],{"id":37},"bad-code","Bad Code",[40,41,46],"pre",{"className":42,"code":43,"language":44,"meta":45,"style":45},"language-javascript shiki shiki-themes github-light github-dark","// This function adds two numbers together\n// It takes two parameters a and b\n// It returns the sum of a and b\nfunction add(a: number, b: number) {\n  // Add a and b\n  return a + b; // return the result\n}\n","javascript","",[47,48,49,57,63,69,75,81,87],"code",{"__ignoreMap":45},[50,51,54],"span",{"class":52,"line":53},"line",1,[50,55,56],{},"// This function adds two numbers together\n",[50,58,60],{"class":52,"line":59},2,[50,61,62],{},"// It takes two parameters a and b\n",[50,64,66],{"class":52,"line":65},3,[50,67,68],{},"// It returns the sum of a and b\n",[50,70,72],{"class":52,"line":71},4,[50,73,74],{},"function add(a: number, b: number) {\n",[50,76,78],{"class":52,"line":77},5,[50,79,80],{},"  // Add a and b\n",[50,82,84],{"class":52,"line":83},6,[50,85,86],{},"  return a + b; // return the result\n",[50,88,90],{"class":52,"line":89},7,[50,91,92],{},"}\n",[28,94,96],{"id":95},"good-code","Good Code",[40,98,100],{"className":42,"code":99,"language":44,"meta":45,"style":45},"/** Adds two numbers. */\nfunction add(a: number, b: number) {\n  return a + b;\n}\n",[47,101,102,107,111,116],{"__ignoreMap":45},[50,103,104],{"class":52,"line":53},[50,105,106],{},"/** Adds two numbers. */\n",[50,108,109],{"class":52,"line":59},[50,110,74],{},[50,112,113],{"class":52,"line":65},[50,114,115],{},"  return a + b;\n",[50,117,118],{"class":52,"line":71},[50,119,92],{},[28,121,123],{"id":122},"configuration","Configuration",[13,125,126],{},"This rule accepts configuration options:",[40,128,132],{"className":129,"code":130,"language":131,"meta":45,"style":45},"language-json shiki shiki-themes github-light github-dark","[\n  {\n    \"type\": \"object\",\n    \"properties\": {\n      \"threshold\": {\n        \"type\": \"number\",\n        \"minimum\": 0,\n        \"maximum\": 1\n      }\n    },\n    \"additionalProperties\": false\n  }\n]\n","json",[47,133,134,140,145,161,169,176,188,200,211,217,223,234,240],{"__ignoreMap":45},[50,135,136],{"class":52,"line":53},[50,137,139],{"class":138},"sVt8B","[\n",[50,141,142],{"class":52,"line":59},[50,143,144],{"class":138},"  {\n",[50,146,147,151,154,158],{"class":52,"line":65},[50,148,150],{"class":149},"sj4cs","    \"type\"",[50,152,153],{"class":138},": ",[50,155,157],{"class":156},"sZZnC","\"object\"",[50,159,160],{"class":138},",\n",[50,162,163,166],{"class":52,"line":71},[50,164,165],{"class":149},"    \"properties\"",[50,167,168],{"class":138},": {\n",[50,170,171,174],{"class":52,"line":77},[50,172,173],{"class":149},"      \"threshold\"",[50,175,168],{"class":138},[50,177,178,181,183,186],{"class":52,"line":83},[50,179,180],{"class":149},"        \"type\"",[50,182,153],{"class":138},[50,184,185],{"class":156},"\"number\"",[50,187,160],{"class":138},[50,189,190,193,195,198],{"class":52,"line":89},[50,191,192],{"class":149},"        \"minimum\"",[50,194,153],{"class":138},[50,196,197],{"class":149},"0",[50,199,160],{"class":138},[50,201,203,206,208],{"class":52,"line":202},8,[50,204,205],{"class":149},"        \"maximum\"",[50,207,153],{"class":138},[50,209,210],{"class":149},"1\n",[50,212,214],{"class":52,"line":213},9,[50,215,216],{"class":138},"      }\n",[50,218,220],{"class":52,"line":219},10,[50,221,222],{"class":138},"    },\n",[50,224,226,229,231],{"class":52,"line":225},11,[50,227,228],{"class":149},"    \"additionalProperties\"",[50,230,153],{"class":138},[50,232,233],{"class":149},"false\n",[50,235,237],{"class":52,"line":236},12,[50,238,239],{"class":138},"  }\n",[50,241,243],{"class":52,"line":242},13,[50,244,245],{"class":138},"]\n",[13,247,248,249,252],{},"Enabled by default in ",[47,250,251],{},"lintmyai:recommended",".",[254,255,256],"style",{},"html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}",{"title":45,"searchDepth":59,"depth":59,"links":258},[259,260,261,262],{"id":30,"depth":59,"text":31},{"id":37,"depth":59,"text":38},{"id":95,"depth":59,"text":96},{"id":122,"depth":59,"text":123},"Boilerplate Bloat","md",false,{},true,"/rules/no-excessive-comments","suggestion",{"title":5,"description":15},"rules/no-excessive-comments","pro",null,"RfyY5urZhEaJoB0SkSlxkjMI5L7v5jv6Qy_GS8ymsUI",1773394825571]