microsoft / microsoft/vscode-cpptools

Documentation comments don't show mathematical formulas in IntelliSense

Aperta
#9,000 3 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

bug Feature: Doc comments Language Service Visual Studio
Lingua principale
TypeScript
Stelle
6.2k
Fork
1.7k
Merge medio
14h 46m
PR unite (30g)
61

Descrizione

Bug type: Language Service

As seen in the attached image, VS-Code doesn't display mathematical formulas in C++ documentation comments.
image

Note that I've inserted some new lines between the doc comments and the function so that you can see them clearly, however this does not affect the issue. It persists when there are no extra new-lines added.

This has been mentioned in this issue, however was marked closed after being determined to somehow be a duplicate of this (seemingly) un-related issue, which was marked as fixed in an older release (1.8.2).

I have tried using various formats to no avail (see the mathematical formula sections of this and this):

  • Different types of block comments:
    • ///
    • /** */
  • Different formula tags (with and without spaces around the formula):
    • @f[formula@f]
    • \f[formula\f]
    • \f{formula\f}
    • \f$formula\f$
  • Inclusion and exclusion of other tags such as @brief, <summary> etc

Additional info:

  • OS: Windows 11 Home x64 - Version 21H2 - Build 22000.493
  • VS Code Version: 1.65.1
  • C/C++ Extension Version: v1.8.4
  • Issue persists when cpptools is the only extension installed

c_cpp_properties.json configuration:

{
    "configurations": [
        {
            "name": "Win32",
            "includePath": [
                "${workspaceFolder}/**",
                "${workspaceFolder}/source"
            ],
            "defines": [
                "_DEBUG",
                "UNICODE",
                "_UNICODE",
            ],
            "windowsSdkVersion": "10.0.19041.0",
            "compilerPath": "C:\\Program Files\\Microsoft Visual Studio\\2022\\Community\\VC\\Tools\\MSVC\\14.30.30705\\bin\\Hostx64\\x64\\cl.exe",
            "cStandard": "c17",
            "cppStandard": "c++17",
            "intelliSenseMode": "windows-msvc-x64",
            "forcedInclude": [
            ]
        }
    ],
    "version": 4
}

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Partite dal rendering IntelliSense dei commenti di documentazione C++ e riproducete il problema in VS Code usando il c_cpp_properties.json e i formati delle formule forniti. Esaminate gli Issues collegati 6136 e 6084 per le indagini precedenti; il lavoro è considerato completato quando le formule matematiche supportate vengono visualizzate nel popup della documentazione. Nel report non sono indicati file sorgente né test.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
cpp, typescript, vscode
Ambito
developer-experience, tooling
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.