boxlang-code-documenterlisted
Install: claude install-skill ortus-boxlang/skills
# BoxLang Code Documenter
## Overview
BoxLang supports Javadoc-style documentation comments. Documenting classes,
functions, and arguments enables IDE tooling, auto-generated API docs, and
serves as inline specification for future maintainers.
---
## Comment Styles
BoxLang supports three comment styles:
```boxlang
// Single-line comment
/* Multi-line
comment */
/**
* Documentation comment (Javadoc-style)
* Used for classes, functions, and components.
*/
```
---
## Class Documentation
Place the doc comment immediately above the `class` keyword:
```boxlang
/**
* UserService handles all user lifecycle operations including creation,
* authentication, profile management, and deactivation.
*
* @author Jane Smith
* @since 2.0.0
* @see UserRepository
*/
class accessors="true" {
property name="userRepo" inject="UserRepository"
property name="emailSvc" inject="EmailService"
}
```
---
## Function Documentation
Document every public function. Place the comment directly above the function:
```boxlang
/**
* Retrieves a user by their unique identifier.
*
* Returns `null` if no user matching `id` is found.
* Throws `UserNotFoundException` if `throwOnMissing` is true.
*
* @param id The unique numeric ID of the user to retrieve.
* @param throwOnMissing When true, throws instead of returning null. Default: false.
*
* @return A Struct containing user data, or null.
*
* @throws UserNotFoundException When throwOnM