Skip to content
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

Jump to bottom

Javadoc style guide: use of <code> vs {@code} #39

Open
javier-godoy opened this issue Aug 21, 2024 · 1 comment
Open

Javadoc style guide: use of <code> vs {@code} #39

javier-godoy opened this issue Aug 21, 2024 · 1 comment
Labels
agreed An agreement on the resolution has been reached

Comments

@javier-godoy
Copy link
Member

Which one (if any) is preferred?

{@code List<String>}

or

<code>List&lt;String&gt;</code>
@javier-godoy
Copy link
Member Author

I think we should favor {@code} unless the <code> has a closing brace } </code>

@javier-godoy javier-godoy changed the title Javasoc style guide: use of code vs {@code} Javasoc style guide: use of <code> vs {@code} Aug 21, 2024
@javier-godoy javier-godoy changed the title Javasoc style guide: use of <code> vs {@code} Javadoc style guide: use of <code> vs {@code} Aug 21, 2024
@javier-godoy javier-godoy mentioned this issue Aug 21, 2024
Open
@javier-godoy javier-godoy added discuss The issue is scheduled for internal discussion agreed An agreement on the resolution has been reached and removed discuss The issue is scheduled for internal discussion labels Aug 21, 2024
javier-godoy added a commit that referenced this issue Sep 23, 2024
@javier-godoy
docs(code-style): document use @code vs <code>
d5064bb 
Close #39
@javier-godoy javier-godoy mentioned this issue Sep 23, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
agreed An agreement on the resolution has been reached
Projects
Flowing Code Addons
Status: In Progress
Milestone
No milestone
Development

No branches or pull requests
1 participant
@javier-godoy