java-docs SKILL.md skillA
java-docs from marielynneblock/arcanum-artifex is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add marielynneblock/arcanum-artifex/java-docs@git:20260710.0115f49Pins git:20260710.0115f49 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- marielynneblock/arcanum-artifex
- Path
skills/development/java/java-docs/SKILL.md- Versions recorded
- 4
- Latest version
- git:20260710.0115f49, committed Jul 10, 2026
- First version recorded
- May 10, 2026
- Size
- 1,486 bytes
- Repository stars
- 4
- License
- none declared
Ensure that Java types are documented with Javadoc comments and follow best practices for documentation.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# Java Documentation (Javadoc) Best Practices
- Public and protected members should be documented with Javadoc comments.
- It is encouraged to document package-private and private members as well, especially if they are complex or not self-explanatory.
- The first sentence of the Javadoc comment is the summary description. It should be a concise overview of what the method does and end with a period.
- Use `@param` for method parameters. The description starts with a lowercase letter and does not end with a period.
- Use `@return` for method return values.
- Use `@throws` or `@exception` to document exceptions thrown by methods.
- Use `@see` for references to other types or members.
- Use `{@inheritDoc}` to inherit documentation from base classes or interfaces.
- Unless there is major behaviour change, in which case you should document the differences.
- Use `@param <T>` for type parameters in generic types or methods.
- Use `{@code}` for inline code snippets.
- Use `<pre>{@code ... }</pre>` for code blocks.
- Use `@since` to indicate when the feature was introduced (e.g., version number).
- Use `@version` to specify the version of the member.
…Read the whole file at its exact version.
How to install
mdr add marielynneblock/arcanum-artifex/java-docs@sha256:c796b8cea0265f75The line at the top of this page pins the label git:20260710.0115f49, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_ndskquhamjbencgz)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 4 versions of this file, between May 10, 2026 and Jul 10, 2026, about one every 20 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260710.0115f49 latest | 2026-07-10 | 0115f49 | 1,486 B | A | view · diff |
| git:20260710.ffb3400 | 2026-07-10 | ffb3400 | 1,485 B | A | view · diff |
| git:20260515.b861afb | 2026-05-15 | b861afb | 1,485 B | A | view · diff |
| git:20260510.f26bcec | 2026-05-10 | f26bcec | 1,439 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (1486 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
marielynneblock/arcanum-artifex · 4 stars · license none declared · pushed 2026-09-19 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_ndskquhamjbencgz GET https://markdownregistry.com/api/v1/resolve?ref=marielynneblock/arcanum-artifex/java-docs GET https://markdownregistry.com/api/v1/blob/c796b8cea0265f752343ef4584f5d62a340ba4fc77a57f6abfc53a6f1aa39f90
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.