boxlang-code-documenter

Generate Javadoc-style comments for BoxLang classes and functions.

16|78|Updated Nov 28, 2014
One-click install
npx skills add https://github.com/ortus-docs/coldbox-docs --skill boxlang-code-documenter
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: boxlang-code-documenter
Source: https://github.com/ortus-docs/coldbox-docs/tree/main/.agents/skills/boxlang-code-documenter
Command: npx skills add https://github.com/ortus-docs/coldbox-docs --skill boxlang-code-documenter

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

BoxLang code often lacks consistent, shareable documentation comments, making maintenance and API understanding harder. This skill provides ready-to-use Javadoc-style comment templates for BoxLang classes and functions and helps align documentation with DocBox tooling.

Core Features & Use Cases

  • Javadoc-style documentation blocks for BoxLang classes and functions
  • Inline parameter and return annotations with @param, @return, and @throws
  • DocBox-compatible templates that simplify API reference generation
  • Guidance on documenting arguments, return values, and usage examples

Quick Start

Create a BoxLang class with a Javadoc-style comment above the class and a function with documented parameters, then generate API docs with DocBox.

Frequently Asked Questions about boxlang-code-documenter

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document BoxLang code with Javadoc-style comments?▼

To document BoxLang code, you add Javadoc-style comment blocks above classes and functions, using @param, @return, and @throws annotations to describe parameters, return values, and exceptions for consistent inline API documentation.

Does BoxLang documentation work with DocBox for API reference generation?▼

Yes, BoxLang documentation works with DocBox. By standardizing Javadoc-style comment templates with @param and @return blocks, the skill ensures your inline comments are compatible and ready for DocBox API reference generation.

What is the best way to standardize inline comments across BoxLang modules?▼

The best way to standardize inline comments is to use structured Javadoc-style templates that define @param, @return, @throws, and example blocks, ensuring consistent API documentation and easier maintenance across all BoxLang modules.

Can I generate usage examples in BoxLang documentation blocks?▼

Yes, you can generate usage examples. The documentation templates include guidance on adding example blocks alongside @param and @return annotations to provide clear usage instructions within your BoxLang codebase.

Why does my BoxLang code lack consistent shareable API documentation?▼

BoxLang code lacks consistent API documentation when inline comments are unstructured. Applying standardized Javadoc-style templates for classes and functions aligns comments and makes the documentation shareable and easier to maintain.