6 replies

Question about Effect's Use of Code Examples in Comments

Why is Effect's codebase full of things like these

/**
 * **Example**
 *
 * `` `ts
 * console.log('hello')
 * `` `
 */

/**
 * **Example**
 *
 * `` `ts
 * console.log('hello')
 * `` `
 */

while the universally recognised by tools

@example

@example

tag achieves the same effect, brings semantic intent, requires less noise, like triple ticks, and could be better handled by JSDoc parsers

/**
 * @example
 * console.log('hello')
 */

/**
 * @example
 * console.log('hello')
 */