Frontmatter
| id | 7890 |
| title | Update Coding Guidelines for Class Top-Level JSDoc Comments and @summary Tag |
| state | Closed |
| labels | documentationenhancementai |
| assignees | tobiu |
| createdAt | Nov 24, 2025, 10:44 AM |
| updatedAt | Nov 24, 2025, 11:06 AM |
| githubUrl | https://github.com/neomjs/neo/issues/7890 |
| author | tobiu |
| commentsCount | 0 |
| parentIssue | null |
| subIssues | [] |
| subIssuesCompleted | 0 |
| subIssuesTotal | 0 |
| blockedBy | [] |
| blocking | [] |
| closedAt | Nov 24, 2025, 11:06 AM |
The current coding guidelines lack explicit instructions for formatting class top-level JSDoc comments, particularly concerning the
@summarytag and the empty line that should follow it before the main description. This leads to inconsistencies in documentation.Goal: Update
.github/CODING_GUIDELINES.mdto:@summaryfor a concise, one-sentence explanation of the class's purpose.@summarytag (or the last single-line tag like@class,@extends) and before the detailed description of the class.