microsoft / vscode-cpptools

Official repository for the Microsoft C/C++ extension for VS Code.
Other
5.53k stars 1.56k forks source link

Description hover do not process '//=====' template #12958

Open dpasukhi opened 4 days ago

dpasukhi commented 4 days ago

Environment

Bug Summary and Steps to Reproduce

Bug Summary: Incorrect processing of comment in the next template:

//=======================================================================
// function : Save
// purpose  :
//=======================================================================
TCollection_AsciiString DE_Wrapper::Save(const Standard_Boolean theIsRecursive,
                                         const TColStd_ListOfAsciiString& theFormats,
                                         const TColStd_ListOfAsciiString& theVendors)
{

The result: Image

For example //~ or //------ working well Image

Steps to reproduce:

  1. Go to any c++ code and write a function separator in //=== /n ... //==== format
  2. Click on method which are having new comment
  3. See incorrect markdown processing

Note: C_Cpp: Markdown In Comments setting in case of "disable" helps to avoid scaling of the //=== template, but === still show in hover

Expected behavior: No scaling of the hover and no ====== is visible in comment.

Configuration and Logs

{
    "configurations": [
        {
            "name": "Linux",
            "includePath": [
                "${workspaceFolder}/src/**"
            ],
            "defines": [],
            "cStandard": "c17",
            "cppStandard": "gnu++17",
            "intelliSenseMode": "linux-clang-x64",
            "mergeConfigurations": true,
            "browse": {
                "databaseFilename": "${workspaceFolder}/build/browse.vc.db",
                "limitSymbolsToIncludedHeaders": false
            },
            "compilerPath": "/usr/bin/clang++-20",
            "compileCommands": "${workspaceFolder}/build/compile_commands.json",
            "configurationProvider": "ms-vscode.cmake-tools"
        }
    ],
    "version": 4
}

Other Extensions

No response

Additional context

No response

sean-mcmanus commented 4 days ago

@dpasukhi It's a bug with our documentation comment implementation. It doesn't repro with VS 2022, which has a different implementation:

Image