TypeDoc: testing code examples in doc comments
Briefly

TypeDoc version 0.27.7 introduced a new feature that allows documentation to include specific parts of external files using the {@includeCode} tag. This is particularly useful for including tested code examples, making documentation clearer and more relevant. Previously, TypeDoc required entire files to be included, often cluttering documentation with unnecessary test boilerplate. The new functionality promotes better coding practices by allowing developers to directly display relevant examples from their tests, thus improving the overall quality and usability of project documentation.
TypeDoc now allows referencing specific code regions from external files using {@includeCode}, improving documentation with tested code examples.
Read at 2ality
[
|
]