Skip to content

docs(code-style): clarify scope of the first-occurrence javadoc rule #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
javier-godoy wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(code-style): clarify scope of the first-occurrence javadoc rule #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions code-style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Flowing Code Style Guide / 1.0.4
# Flowing Code Style Guide / 1.0.5

In any file format, maintain a consistent style for indentation and alignment throughout the entire file. Do not use tab characters on some lines and a fixed amount of whitespace on others, as their display can differ across devices and platforms.

Expand Down Expand Up @@ -68,7 +68,7 @@ Examples:

Prefer `{@code}` over `<code>`, unless the code contains a closing brace (`}`).

In each comment, the first occurrence of an identifier that refers to a class, field, or method must be enclosed in a `{@link}` tag. Otherwise, the identifier must be wrapped in `{@code}` (or `<code>` see #39).
In each comment, the first occurrence of an identifier that refers to a class, field, or method must be enclosed in a `{@link}` tag. Otherwise, the identifier must be wrapped in `{@code}` (or `<code>` see #39). Each Javadoc comment is treated as a unique scope for this rule.

The following identifiers must never be linked and should always be wrapped in `{@code}:`
- The name of the type being documented, or the type where the documented method/field is located.
Expand Down