How to get Clion like function description in VS code?

When it comes to coding, having a good understanding of the functions you are using is essential. Clion, a popular integrated development environment (IDE), provides a helpful feature that displays function descriptions as you type. If you are using Visual Studio Code (VS Code) and would like to have a similar function description feature, you're in luck! In this article, we will guide you through the process of getting Clion-like function descriptions in VS Code.

Step 1: Install the IntelliSense Extension

The first step is to install the IntelliSense extension for Visual Studio Code. IntelliSense is a built-in code completion feature that provides suggestions and information about functions, variables, and more. To install the extension, follow these steps:

1. Open Visual Studio Code.
2. Click on the Extensions icon in the left sidebar.
3. Search for "IntelliSense" in the Extensions Marketplace.
4. Click on the IntelliSense extension by Microsoft.
5. Click the Install button to install the extension.

Step 2: Configure IntelliSense

After installing the IntelliSense extension, you need to configure it to provide function descriptions. Follow these steps:

1. Open your Visual Studio Code settings by clicking on File > Preferences > Settings.
2. In the settings search bar, type "intellisense.documentationMode".
3. Under IntelliSense, you will find the "Intellisense: Documentation Mode" setting. Click on the "Edit in settings.json" link.
4. In the settings.json file, add the following line:

This configuration sets the documentation mode to "signature", which means that function descriptions will be displayed based on their signatures.

Step 3: Enable Parameter Hints

Parameter hints are another useful feature that can enhance your coding experience. They display the names of the parameters a function expects while you are typing. To enable parameter hints, follow these steps:

1. Open your Visual Studio Code settings.
2. In the settings search bar, type "editor.parameterHints".
3. Under Editor, you will find the "Editor: Parameter Hints" setting. Click on the "Edit in settings.json" link.
4. In the settings.json file, add the following line:

Enabling this setting will display parameter hints as you type, making it easier to understand the function's expected parameters.

Step 4: Install Language Support Extensions

Depending on the programming language you are working with, you may need to install additional language support extensions to get accurate function descriptions. For example, if you are coding in JavaScript, you can install the "JavaScript (ES6) code snippets" extension to enhance the function descriptions. To install language support extensions, follow these steps:

1. Open Visual Studio Code.
2. Click on the Extensions icon in the left sidebar.
3. Search for the language support extension you need (e.g., "JavaScript (ES6) code snippets").
4. Click on the extension and then click the Install button to install it.

Repeat this step for any other programming languages you are working with.

Step 5: Enjoy Clion-like Function Descriptions!

Now that you have completed the necessary configurations, you can start enjoying Clion-like function descriptions in Visual Studio Code. As you type a function, you will see a tooltip displaying the function's signature and description. Parameter hints will also be displayed, making it easier to understand the function's expected parameters.

Remember to save your files after making any changes to the configuration settings for the changes to take effect.

Congratulations! You have successfully set up Clion-like function descriptions in Visual Studio Code. This feature will greatly improve your coding experience and help you better understand the functions you are using.

Having function descriptions at your fingertips while coding is a valuable asset. With the help of the IntelliSense extension and the proper configurations, you can bring Clion-like function descriptions to Visual Studio Code. By following the steps outlined in this article, you are now equipped with the knowledge to enhance your coding experience and improve your understanding of the functions you use.

References