Как изменить разбор комментариев к документации или хотя бы отключить Markdown там в VS Code? - PullRequest
0 голосов
/ 04 апреля 2020

Недавно мой VS-код начал строго анализировать комментарии документации (например, комментарии JSDo c) как Markdown для JavaScript и TypeScript. Хотя я большой поклонник Markdown, я не очень большой поклонник того, как он удаляет мои отдельные строки из комментариев к документации. Я не хочу использовать JSDo c и установил собственный стиль комментариев к документации, который предназначен не для возможности генерировать документацию HTML, а для максимальной читабельности и компактности в самом коде.

Мне нравится функция IntelliSense, которая автоматически отображает документацию из комментария во всплывающей подсказке над символом. Теперь, когда мои символы новой строки удалены, это еще менее полезно, чем раньше, когда он только что удалил мои отступы и табуляции.

/**
    Does various foo-related stuff.
    <=  a - put your age here
    <=  b - place banana here
    <=  c : boolean - whether you are on the sea right now
    =>  - the answer to all of your questions
*/
function foo(a, b, c)
{}

Documentation from comment as displayed by IntelliSense quick info

Есть ли способ или не иметь отдельные символы новой строки или полностью отключить Markdown для этих комментариев? Я был бы рад, если бы я просто отображал свои комментарии в моноширинном шрифте.

Кстати, кроме того, что <br/> не работало в моих тестах, это не было бы для меня альтернативой. , Несмотря на то, что это неуклюже и утомительно, я думал об использовании блоков кода Markdown для отображения моноширинного дисплея в формате 1: 1, но все довольно плохо, и моя проблема была перенесена в отставание .

Или вы можете дать мне несколько советов, где я мог бы добиться этого путем исправления кода VS Code самостоятельно? Я обнаружил, что языки , по-видимому, предоставляют своего рода услугу быстрой информации для этой цели , и поинтересовался, есть ли какие-либо хуки или есть возможность добавить новый синтаксис комментариев (например, /*~ ... */) и предоставить собственный парсеры отделены от функциональности, которая фактически находит документацию для символа.

...