File
public/uploads/rules/do-you-comment-your-javascript-code/rule.mdx
Finding
The rule (lastUpdated 2015) gives general advice about comments but doesn't mention modern tooling, TypeScript types, JSDoc, or when to prefer self-documenting code and automated API documentation.
Suggestions
- Update to recommend using JSDoc/TypeScript for public APIs and prefer self-documenting code combined with concise comments.
- Recommend linters and documentation generation tools (ESLint rules, TypeDoc) and avoid examples like document.write.
- Add examples of good comment practices for modern JS/TS projects.
contenthawk-run-id: 24868294451
Generated by Content Judge (Agent 2a) · ◷
File
public/uploads/rules/do-you-comment-your-javascript-code/rule.mdxFinding
The rule (lastUpdated 2015) gives general advice about comments but doesn't mention modern tooling, TypeScript types, JSDoc, or when to prefer self-documenting code and automated API documentation.
Suggestions
contenthawk-run-id: 24868294451