Skip to main content
This annotation is intended for complex cases and is primarily designed to be used by the built-in annotations.

Overview

@module declares a file as a named module. Documentation tools use that name when they build module pages or process annotation files.

Syntax


Usage


When to use

  • In library files that are consumed via require()
  • In generated stubs and meta declaration files
  • When documentation tools need a module name
For most addon development, you can skip @module. GLuaLS resolves modules by file path. Use @module when you generate docs or build definition files for distribution.

See also

  • @meta: Mark a file as a type-only declaration file (not runtime code)