docTextfunctionfunction docText(comments: readonly Comment[]): stringThe documentation text of comments, in order, joined by new lines.
| Parameter | What it is |
|---|---|
comments | comments of any kind |
Returns: their text with the markers taken off
The text of documentation comments (commons lang-sql 0004-sql-docs FR-001): a comment with its markers taken off, whatever kind it is. A line comment loses its marker, any run of the marker's last character that follows it (---, ///, ##) and one space; a block comment loses its delimiters, and on each line its white space, any * and one space; consecutive comments are joined by a new line.
docText(parse("--- The people.\n--- Of the company.\nCREATE TABLE t (a INT)").comments); // "The people.\nOf the company."Spec: 0004-sql-docs FR-001
docTextfunctionfunction docText(comments: readonly Comment[]): stringThe documentation text of comments, in order, joined by new lines.
| Parameter | What it is |
|---|---|
comments | comments of any kind |
Returns: their text with the markers taken off