Difference between revisions of "Docgen Visual Studio Code Integration"

From Gehtsoft USA
Jump to: navigation, search
(Created page with "http://cloud.gehtsoft.com/index.php/s/Nddy6s4pbDCQGBQ Category:Docgen")
 
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
http://cloud.gehtsoft.com/index.php/s/Nddy6s4pbDCQGBQ
+
Требования:
 +
Visual Studio Code 1.37 или выше
 +
ОС Windows
 +
 
 +
Как установить:
 +
code --install-extension ''packagename.vsix''
 +
 
 +
Что поддерживается:
 +
* подсветка синтаксиса
 +
* подсказки по именам тегов, свойств, bb-кодам
 +
* если есть файл проекта - то подсказки для @ingroup, [link], [clink] с ключами
 +
* если есть файл проекта - до поддерживается go declaration
 +
* команда docgen.gomatch для перехода между началом и концом тега
 +
 
 +
Ограничения:
 +
* и файл проекта и файлы исходняков должны быть в utf-8
 +
* файл проекта должен называться project.xml и лежать в головной папке проекта
 +
* список ключей обновляется только при сохранении файла и файла проекта
 +
* если файл добавлен в папку которая включается в проект через folder - то для того чтобы extension увидел новый файл - надо сохранить файл проекта
 +
 
 +
Скачать последнюю версию расширения
 +
https://www.myget.org/F/gehtsoft-public/vsix/docgen-0.0.5.vsix
 +
 
 +
Для того что бы сделать spellchecking:
 +
 
 +
* Установить расширение https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
 +
* создать папку .vscode в корне проекта
 +
* создать файл settings.json в папке .vscode или добавить следующие ключи если этот файл уже есть
 +
<pre>
 +
{
 +
    "cSpell.enableFiletypes": [
 +
        "docgen"
 +
    ],
 +
    "cSpell.maxNumberOfProblems": 300,
 +
    "cSpell.minWordLength": 3,
 +
    "cSpell.enabled": true,
 +
    "cSpell.showStatus": true,
 +
    "cSpell.words": [
 +
        "gehtsoft",
 +
        "namespace",
 +
        "guid",
 +
        "accessor",
 +
    ],
 +
    "cSpell.ignoreRegExpList": [
 +
        "/\\[[^\\]]+\\]/",
 +
        "/^\\s*@ingroup\\s*=.+$/m",
 +
        "/^\\s*@sig\\s*=.+$/m",
 +
        "/^\\s*@key\\s*=.+$/m",
 +
        "/^\\s*@name\\s*=.+$/m",
 +
        "/^\\s*@parent\\s*=.+$/m",
 +
        "/^\\s*@\\w+\\s*$/m"
 +
    ],
 +
}
 +
</pre>
  
 
[[Category:Docgen]]
 
[[Category:Docgen]]

Latest revision as of 16:57, 28 September 2020

Требования: Visual Studio Code 1.37 или выше ОС Windows

Как установить: code --install-extension packagename.vsix

Что поддерживается:

  • подсветка синтаксиса
  • подсказки по именам тегов, свойств, bb-кодам
  • если есть файл проекта - то подсказки для @ingroup, [link], [clink] с ключами
  • если есть файл проекта - до поддерживается go declaration
  • команда docgen.gomatch для перехода между началом и концом тега

Ограничения:

  • и файл проекта и файлы исходняков должны быть в utf-8
  • файл проекта должен называться project.xml и лежать в головной папке проекта
  • список ключей обновляется только при сохранении файла и файла проекта
  • если файл добавлен в папку которая включается в проект через folder - то для того чтобы extension увидел новый файл - надо сохранить файл проекта

Скачать последнюю версию расширения https://www.myget.org/F/gehtsoft-public/vsix/docgen-0.0.5.vsix

Для того что бы сделать spellchecking: 

{
    "cSpell.enableFiletypes": [
        "docgen"
    ],
    "cSpell.maxNumberOfProblems": 300,
    "cSpell.minWordLength": 3,
    "cSpell.enabled": true,
    "cSpell.showStatus": true,
    "cSpell.words": [
        "gehtsoft",
        "namespace",
        "guid",
        "accessor",
    ],
    "cSpell.ignoreRegExpList": [
        "/\\[[^\\]]+\\]/",
        "/^\\s*@ingroup\\s*=.+$/m",
        "/^\\s*@sig\\s*=.+$/m",
        "/^\\s*@key\\s*=.+$/m",
        "/^\\s*@name\\s*=.+$/m",
        "/^\\s*@parent\\s*=.+$/m",
        "/^\\s*@\\w+\\s*$/m"
    ],
}
Retrieved from "https://wiki.gehtsoftusa.com/index.php?title=Docgen_Visual_Studio_Code_Integration&oldid=162"