Introducing automatic documentation comment generation in Visual Studio
Table of Contents
Introduction
Automatic documentation comment generation in Visual Studio is now integrated with Copilot to assist in generating doc comments for functions. This feature aims to streamline the documentation process and enhance the coding experience for users with a GitHub Copilot subscription.
AI Doc Comment Generation
With automatic doc comment generation enabled, users can type triggers for doc comment formats (such as ///) and Copilot suggestions will automatically fill out function descriptions based on the function's contents, including summaries, parameters, and return types. Suggestions can be accepted with a single tab, similar to regular Copilot code completions.
How to Enable Doc Comments
To access this feature, users need to have automatic doc comments generation enabled, which can be configured for C++ projects by adjusting the documentation comment styles in Tools > Options. Both XML and Doxygen style comments are supported. For C# projects, a similar setting needs to be enabled in Tools > Options.
Share Your Feedback
This feature is available in Visual Studio 17.14 Preview 2 for both C# and C++ projects. Users are encouraged to explore this feature and experience how GitHub Copilot can simplify and transform the coding process. Feedback from users is greatly appreciated, as it helps drive continuous improvement and innovation in Visual Studio.
Happy coding!