microsoft / microsoft/vscode-cpptools

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

Open
#12,958 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug Feature: Doc comments Language Service Works in VS
Dominant language
TypeScript
Stars
6.2k
Forks
1.7k
Avg merge
14h 46m
Merged PRs (30d)
61

Description

Environment
  • OS and Version: Any
  • VS Code Version: 1.96
  • C/C++ Extension Version: 1.3.0
  • If using SSH remote, specify OS of remote machine:
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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue in a C++ file using the //===== separator and inspect the C/C++ extension's hover markdown processing, including the C_Cpp: Markdown In Comments setting. Done means the hover neither scales the separator nor displays the equals characters as visible markdown content.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, typescript, vscode
Domain
developer-experience, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.