LearnNewsExamplesServices
Frontmatter
id7894
titleUpdate Coding Guidelines to mandate @summary as first tag
stateClosed
labels
documentationenhancementai
assigneestobiu
createdAtNov 24, 2025, 12:03 PM
updatedAtNov 24, 2025, 12:04 PM
githubUrlhttps://github.com/neomjs/neo/issues/7894
authortobiu
commentsCount0
parentIssuenull
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtNov 24, 2025, 12:04 PM

Update Coding Guidelines to mandate @summary as first tag

Closed v11.10.0 documentationenhancementai
tobiu
tobiu commented on Nov 24, 2025, 12:03 PM

The coding guidelines (item 18) should explicitly state that the @summary tag must be the first item in the JSDoc block for classes, followed by an empty line and then the description. This ensures consistency across the codebase.

tobiu added the documentation label on Nov 24, 2025, 12:03 PM
tobiu added the enhancement label on Nov 24, 2025, 12:03 PM
tobiu added the ai label on Nov 24, 2025, 12:03 PM
tobiu assigned to @tobiu on Nov 24, 2025, 12:04 PM
tobiu referenced in commit a48428b - "Update Coding Guidelines to mandate @summary as first tag #7894" on Nov 24, 2025, 12:04 PM
tobiu closed this issue on Nov 24, 2025, 12:04 PM