Always use JSDoc format (`/** */`) instead of regular comments (`//`) for documenting classes, functions, and interfaces. Documentation should be comprehensive, including:
Always use JSDoc format (/** */) instead of regular comments (//) for documenting classes, functions, and interfaces. Documentation should be comprehensive, including:
@internal for non-public API elements{@link ...} syntaxThis ensures that documentation integrates correctly with API reference generators and provides developers with sufficient context.
Example - Before:
// this class uses your clientId, clientSecret and redirectUri
// to get access token and refresh token, if you already have them,
// you can use AuthFlowToken or AuthFlowRefresh instead
export class AuthFlow {
// ...
}
Example - After:
/**
* Authentication flow for obtaining access and refresh tokens using clientId,
* clientSecret and redirectUri.
*
* @example
* const auth = new AuthFlow({
* clientId: process.env.CLIENT_ID,
* clientSecret: process.env.CLIENT_SECRET,
* redirectUri: "http://localhost:3000/callback"
* });
* const tokens = await auth.getTokens();
*
* @see If you already have tokens, consider using {@link AuthFlowToken} or
* {@link AuthFlowRefresh} instead.
*/
export class AuthFlow {
// ...
}
Enter the URL of a public GitHub repository