Skip to content

Add IntelliSense Configuration Doc #6614

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

AlexandraKemperMS
Copy link
Collaborator

Part of the Plan to update our docs with the newest features. Features covered in this update:

  • Language Status Bar
  • Status Bar Indicator
  • Configuration Quickpick

I made this doc separate from the "Configuring IntelliSense for cross compilation" document so that it can be a one stop shop for how to identify if you have IntelliSense configured & if not, how to do so. The details of the c_pp_properties file schema are still addressed in the separate doc.

@AlexandraKemperMS
Copy link
Collaborator Author

This PR is not ready for review - I am checking if the format is rendering correctly & the c_pp_properties schema file is not updated yet.

@gregvanl
Copy link

Adding don't merge label until this is ready

@AlexandraKemperMS
Copy link
Collaborator Author

The PR is now ready for review, I have shared it with the team to also take a look.


![configure-intelliSense-indicator-status-bar](images/intellisense/configure-intellisense-indicator.png)

To configure, select the status bar indicator, which navigates you to the [configuration quickpickpick](/docs/cpp/configure-intellisense#_selecting-a-compiler-for-IntelliSense.md). The status bar indicator also is shown if you have provided a configuration for IntelliSense, but the C/C++ Extension is reverting to the base configuration provided in your `c_cpp_properties.json` file. In this case, open the `c_cpp_properties.json` file (Select **C/C++: Edit Configurations (UI)** from the Command Palette (`kb(workbench.action.showCommands)`)).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

format should be (/docs/cpp/configure-intellisense.md#selecting-a-compiler-for-intellisense)
but I'm not sure that header exists

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated all the places this header was referenced - it is supposed to link to the configuration quickpick section, which I had renamed since creating the links.

@gregvanl gregvanl added C++ and removed don't merge labels Aug 30, 2023
"cStandard": "c11",
"cppStandard": "c++17",
"cStandard": "c23",
"cppStandard": "c++23",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these the current defaults?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No - I believe the current defaults are c17/c++17? I wanted to use the most recent version to encourage users to use the most recent versions.


- A C/C++ compiler
- `compile_commands.json` file
- Another extension (for example, the [Makefile Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.makefile-tools) or [CMake extension](/docs/cpp/CMake-linux.md)).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be for example, the [Makefile Tools](...) or [CMake Tools](..) extension

@AlexandraKemperMS AlexandraKemperMS marked this pull request as draft October 17, 2023 23:21
@AlexandraKemperMS AlexandraKemperMS marked this pull request as ready for review November 1, 2023 20:25
@AlexandraKemperMS
Copy link
Collaborator Author

AlexandraKemperMS commented Nov 1, 2023

Hi @bobbrow and @gregvanl, this is now ready for review. Just an FYI that the Samples are supposed to show up as unopened dropdowns, similar to the VS Code API Reference page:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants