LearnNewsExamplesServices
Frontmatter
id7890
titleUpdate Coding Guidelines for Class Top-Level JSDoc Comments and @summary Tag
stateClosed
labels
documentationenhancementai
assigneestobiu
createdAtNov 24, 2025, 10:44 AM
updatedAtNov 24, 2025, 11:06 AM
githubUrlhttps://github.com/neomjs/neo/issues/7890
authortobiu
commentsCount0
parentIssuenull
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtNov 24, 2025, 11:06 AM

Update Coding Guidelines for Class Top-Level JSDoc Comments and @summary Tag

Closed v11.10.0 documentationenhancementai
tobiu
tobiu commented on Nov 24, 2025, 10:44 AM

The current coding guidelines lack explicit instructions for formatting class top-level JSDoc comments, particularly concerning the @summary tag and the empty line that should follow it before the main description. This leads to inconsistencies in documentation.

Goal: Update .github/CODING_GUIDELINES.md to:

  1. Define the usage of @summary for a concise, one-sentence explanation of the class's purpose.
  2. Mandate an empty line after the @summary tag (or the last single-line tag like @class, @extends) and before the detailed description of the class.
tobiu added the documentation label on Nov 24, 2025, 10:44 AM
tobiu added the enhancement label on Nov 24, 2025, 10:44 AM
tobiu added the ai label on Nov 24, 2025, 10:44 AM
tobiu assigned to @tobiu on Nov 24, 2025, 10:44 AM
tobiu referenced in commit 04b4d1f - "Update Coding Guidelines for Class Top-Level JSDoc Comments and @summary Tag #7890" on Nov 24, 2025, 11:06 AM
tobiu closed this issue on Nov 24, 2025, 11:06 AM