Write and refine Javadoc comments for Java types and members. Apply consistent summaries and tags for parameters, return values, exceptions, inherited behavior, code examples, version information, and deprecated members with suggested alternatives.
Ensure that Java types are documented with Javadoc comments and follow best practices for documentation.
Review the instructions the agent will receive before you install.
@param for method parameters. The description starts with a lowercase letter and does not end with a period.@return for method return values.@throws or @exception to document exceptions thrown by methods.@see for references to other types or members.{@inheritDoc} to inherit documentation from base classes or interfaces.
@param <T> for type parameters in generic types or methods.{@code} for inline code snippets.<pre>{@code ... }</pre> for code blocks.@since to indicate when the feature was introduced (e.g., version number).@version to specify the version of the member.@author to specify the author of the code.@deprecated to mark a member as deprecated and provide an alternative.No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Map an existing codebase into seven documents covering its technology, structure, architecture, conventions, integrations, tests, and concerns. Link findings to file evidence, mark unknowns, and highlight differences between stated plans and the actual implementation.
Assess a repository’s readiness for AI agents with AgentRC and generate a standalone HTML dashboard. Review scores across nine areas, see prioritized improvements, and optionally apply scoring policies tailored to an organization.
Generate coding agent instruction files from a project's actual code using AgentRC. Capture detected languages, frameworks, and conventions in one shared file or split rules by topic and project area, with a preview before writing.
Customize AgentRC readiness assessments to match team or organization standards. Choose or create policies that adjust check importance, disable irrelevant checks, set pass thresholds, and define requirements for automated checks in CI workflows.
Analyze supplied ad performance data to identify wasted spend, strong campaigns, and next tests. Compare channels, assess whether test differences are meaningful, and produce budget reallocation recommendations with a prioritized action plan.
Turn code files into learning resources by adding comments that explain syntax, programming concepts, and design choices. Adjust explanation depth and repetition to the reader’s knowledge while preserving file structure, encoding, and syntax.