1. IT-Security >
  2. Programmierung >
  3. Doxygen and XML Doc Comment support

ArabicEnglishFrenchGermanGreekItalianJapaneseKoreanPersianPolishPortugueseRussianSpanishTurkishVietnamese

Doxygen and XML Doc Comment support


Programmierung vom | Direktlink: devblogs.microsoft.com Nachrichten Bewertung

Whether you’re using Doxygen or XML Doc Comments, Visual Studio version 16.6 Preview 2 provides automatic comment stub generation as well as Quick Info, Parameter Help, and Member List tooltip support.

Stub Generation

By default, the stub generation is set to XML Doc Comments. The comment stub can be generated by typing a triple slash (///) or by using the documentation generation shortcut (Ctrl+/) above the function.

XML Doc Comment
Image quadraticXMLgen
Doxygen

To switch to Doxygen, type “Doxygen” in the Ctrl+Q search box, or go to Tools > Options > Text Editor > C/C++ > > General, and choose your preferred documentation style:

Image documentationOptions

Once specified, you can generate the comment stub by typing the respective “///” or “/**” above a function, or by using the (Ctrl+/) shortcut.

You can also specify this documentation option on a per-folder or per-file basis via .editorconfig files with the corresponding setting:

vc_generate_documentation_comments = none

vc_generate_documentation_comments = xml

vc_generate_documentation_comments = doxygen_triple_slash

vc_generate_documentation_comments = doxygen_slash_star

To get started, you can have Visual Studio generate an .editorconfig file for you based on your existing setting for documentation by using the “Generate .editorconfig file from settings” button shown in the screenshot above.

Image QuadraticDoxygen

Tooltip Display

Documentation artifacts will now appear in Quick Info, Member List, and Parameter Help tooltips:

Image tooltips

 

Give us your feedback

Download Visual Studio 2019 version 16.6 Preview 2 today and give this new documentation support a try. We can be reached via the comments below, email ([email protected]), and Twitter (@VisualC). The best way to file a bug or suggest a feature is via Developer Community.

The post Doxygen and XML Doc Comment support appeared first on C++ Team Blog.

...

Externe Webseite mit kompletten Inhalt öffnen



https://devblogs.microsoft.com/cppblog/doxygen-and-xml-doc-comment-support/

Team Security Social Media

➤ Weitere Beiträge von Team Security | IT Sicherheit

  • C++ Cross-Platform Development with Visual Studio 2019 version 16.3: vcpkg, CMake configuration, remote headers, and WSL

    vom 1111.91 Punkte ic_school_black_18dp
    In Visual Studio 2019 you can target both Windows and Linux from the comfort of a single IDE. Visual Studio’s native support for CMake lets you open any folder containing C++ code and a CMakeLists.txt file directly in Visual Studio to edit, build, and debug your CMake project on Windows, Linux
  • Clear, Functional C++ Documentation with Sphinx + Breathe + Doxygen + CMake

    vom 1087.96 Punkte ic_school_black_18dp
    Writing good documentation is hard. Tools can’t solve this problem in themselves, but they can ease the pain. This post will show you how to use Sphinx to generate attractive, functional documentation for C++ libraries, supplied with information from Dox
  • Python in Visual Studio Code – November 2019 Release

    vom 851.49 Punkte ic_school_black_18dp
    We are pleased to announce that the November 2019 release of the Python Extension for Visual Studio Code is now available. You can  download the Python extension from the Marketplace, or install it directly from the extension gallery in Visual Studio Code. If you alr
  • Visual Studio 2019 version 16.1 now generally available (and 16.2 Preview 1 as well)

    vom 811.55 Punkte ic_school_black_18dp
    Today, we are making Visual Studio 2019 version 16.1 generally available, as well as the first preview release of Visual Studio 2019 version 16.2. You can download both versions from VisualStudio.com. If you already have Preview installed, 
  • Python in Visual Studio Code – March 2020 Release

    vom 746.95 Punkte ic_school_black_18dp
    We are pleased to announce that the March 2020 release of the Python Extension for Visual Studio Code is now available. You can download the Python extension from the Marketplace, or install it directly from the extension gallery in Visual Studio Code. If you already have the
  • Python in Visual Studio Code – September 2019 Release

    vom 650.29 Punkte ic_school_black_18dp
    We are pleased to announce that the September 2019 release of the Python Extension for Visual Studio Code is now available. You can download the Python extension from the Marketplace, or install it directly from the extension gallery in Visual Stud
  • Python in Visual Studio Code – August 2019 Release

    vom 644.43 Punkte ic_school_black_18dp
    We are pleased to announce that the August 2019 release of the Python Extension for Visual Studio Code is now available. You can download the Python extension from the Marketplace, or install it directly from the extension gallery in Visual Studio Code.
  • Visual Studio 2019 for Mac version 8.1 is now available (and a Preview for 8.2)

    vom 631.91 Punkte ic_school_black_18dp
    Today, we are excited to announce the release of Visual Studio 2019 for Mac version 8.1 along with the first preview of Visual Studio 2019 for Mac version 8.2. Both releases contain exciting new features as well as improvements to performance a
  • Python in Visual Studio Code – October 2019 Release

    vom 573.78 Punkte ic_school_black_18dp
    We are pleased to announce that the October 2019 release of the Python Extension for Visual Studio Code is now available. You can download the Python extension from the Marketplace, or install it directly from the extension gallery in Visual Studio Code. If you
  • Visual Studio 2019 version 16.2 Preview 2

    vom 443.19 Punkte ic_school_black_18dp
    We are announcing the release of the second preview of Visual Studio 2019 version 16.2. The latest version is available for you to download from VisualStudio.com, or, if you already have the Preview installed, just click the notification bell from inside Vi
  • warning: file /usr/lib/node_modules/npm/scripts/index-build.js: remove failed: No such file or directory warning: file

    vom 384.61 Punkte ic_school_black_18dp
    Hello everyone , I have to update amazon linux server for partners, I encounter many warnings that there are no files or folders in nodejs like this, will it affect the system? , I think yum update has this warning because it didn't have any files or folde
  • RetDec - A Retargetable Machine-Code Decompiler Based On LLVM

    vom 300.39 Punkte ic_school_black_18dp
    RetDec is a retargetable machine-code decompiler based on LLVM.The decompiler is not limited to any particular target architecture, operating system, or executable file format:Supported file formats: ELF, PE, Mach-O, COFF, AR (archive), Intel HEX, and ra

Team Security Diskussion über Doxygen and XML Doc Comment support