Annotation Reference

/**
* Creates a new user account.
* @param {string} name - The user display name
* @param {string} email - The user email
* @returns {Promise<User>} The created user
* @since v2.0
* @deprecated Use createUserV2 instead
* @category Authentication
* @example
* const user = await createUser("Alice", "alice@example.com")
*/
export async function createUser(name: string, email: string): Promise<User> { }

Supported tags: @param, @returns / @return, @deprecated, @since, @see, @example, @internal / @private / @hidden (excludes from docs), @category / @group / @module (grouping). Optional params via @param {type} [name].

Google, NumPy, and Sphinx/reST docstring styles are all recognized:

def fetch_user(user_id: str, include_profile: bool = False) -> User:
"""Fetches a user from the database.

Args:
user_id (str): The unique user identifier
include_profile (bool, optional): Whether to include profile data

Returns:
User: The found user object

Raises:
NotFoundError: If user doesn't exist

Examples:
>>> user = fetch_user("abc123")
"""

Recognized sections: Args: / Arguments: / Parameters:, Returns:, Raises:, Example(s):, Attributes:, plus reST :param: / :type: / :returns: / :rtype: and NumPy Parameters ---------- style.

// NewClient creates a new API client with the given configuration.
// It validates the config and returns an error if the provided
// endpoints are unreachable.
func NewClient(config Config) (*Client, error) { }

// Deprecated: Use NewClientV2 instead.
func OldClient() *Client { }

The comment block becomes the description. A Deprecated: prefix marks the symbol deprecated.

/// Creates a new buffer with the specified capacity.
///
/// # Arguments
///
/// * `capacity` - Initial capacity in bytes
///
/// # Returns
///
/// A new empty buffer.
///
/// # Examples
///
/// ```rust
/// let buf = Buffer::new(1024);
/// ```
pub fn new(capacity: usize) -> Buffer { }

Recognized sections: # Arguments / # Parameters, # Returns, # Example(s), # Panics, # Errors, # Safety.

/**
* Creates a new user in the system.
*
* @param username the desired username
* @param email the user email address
* @return the created User object
* @since 2.0
* @see UserService
*/
public User createUser(String username, String email) { }

Same tag set as JSDoc. Framework annotations (@Override, @Autowired, …) on the definition line are skipped.

/**
* Sends an email notification to the user.
*
* @param string $to The recipient email address
* @param string $subject The email subject line
* @return bool Whether the email was sent successfully
* @category Notifications
*/
function sendEmail(string $to, string $subject): bool { }

The $ prefix on parameter names is normalized automatically.

/// <summary>
/// Creates a new user account in the system.
/// </summary>
/// <param name="username">The desired username</param>
/// <returns>The created user object</returns>
/// <seealso cref="UpdateUser"/>
public async Task<User> CreateUser(string username, string email) { }

Recognized elements: <summary>, <remarks>, <param>, <returns>, <example> / <code>, <see> / <seealso>, <paramref>, <c>. Attributes like [HttpGet] are skipped.