mirror of https://github.com/FabricMC/yarn.git
Add javadocs convention (#1790)
* Add javadocs convention * Update CONVENTIONS.md
This commit is contained in:
parent
6cc1a9368a
commit
83d6b1581d
|
@ -43,6 +43,7 @@ time to type thanks to IDE autocompletion. Common abbreviations you should use a
|
||||||
- "pos" for "position"
|
- "pos" for "position"
|
||||||
- "nbt" for "named binary tag"
|
- "nbt" for "named binary tag"
|
||||||
- "init" for "initialize"
|
- "init" for "initialize"
|
||||||
|
- "min"/"max" for "minimum"/"maximum"
|
||||||
- Any abbreviations used by Java or libraries ("json", "html", etc.)
|
- Any abbreviations used by Java or libraries ("json", "html", etc.)
|
||||||
|
|
||||||
Treat acronyms as single words rather than capitalising every letter. This improves readability (compare `JsonObject` and
|
Treat acronyms as single words rather than capitalising every letter. This improves readability (compare `JsonObject` and
|
||||||
|
@ -113,6 +114,14 @@ front of the coordinate (`velocityX`, not `xVelocity`).
|
||||||
|
|
||||||
Name screen coordinates `x` and `y`, rather than `left` and `top`.
|
Name screen coordinates `x` and `y`, rather than `left` and `top`.
|
||||||
|
|
||||||
|
## Javadocs
|
||||||
|
|
||||||
|
Write sentences for class, method and fields javadocs, starting with an uppercase and ending with a period. Start method docs with verbs, like `Gets` or `Called`. Use HTML tags such as `<p>` if the docs have several paragraphs.
|
||||||
|
|
||||||
|
Write quick descriptions for parameter javadocs as well as `@return` tags, with no uppercase or period. Add parameter docs to the parameter itself instead of using the `@param` tag.
|
||||||
|
|
||||||
|
Use `@link`, `@linkplain` and `@see` tags to refer to other parts of the code.
|
||||||
|
|
||||||
## Mojang names
|
## Mojang names
|
||||||
|
|
||||||
**Do not use names from Mojang's obfuscation maps.**
|
**Do not use names from Mojang's obfuscation maps.**
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
# Done to increase the memory available to gradle.
|
# Done to increase the memory available to gradle.
|
||||||
org.gradle.jvmargs=-Xmx1G
|
org.gradle.jvmargs=-Xmx1G
|
||||||
|
|
||||||
enigma_version=0.21+build.218
|
enigma_version=0.21.4+build.225
|
||||||
stitch_version=0.5.1+build.77
|
stitch_version=0.5.1+build.77
|
||||||
|
|
Loading…
Reference in New Issue