Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • World
  • Users
  • Groups
Skins
  • Light
  • Cerulean
  • Cosmo
  • Flatly
  • Journal
  • Litera
  • Lumen
  • Lux
  • Materia
  • Minty
  • Morph
  • Pulse
  • Sandstone
  • Simplex
  • Sketchy
  • Spacelab
  • United
  • Yeti
  • Zephyr
  • Dark
  • Cyborg
  • Darkly
  • Quartz
  • Slate
  • Solar
  • Superhero
  • Vapor

  • Default (No Skin)
  • No Skin
Collapse
Code Project
  1. Home
  2. General Programming
  3. C / C++ / MFC
  4. Properly document C++ code for use in Intellisense ?

Properly document C++ code for use in Intellisense ?

Scheduled Pinned Locked Moved C / C++ / MFC
c++questionvisual-studiocomdevops
2 Posts 2 Posters 0 Views 1 Watching
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • M Offline
    M Offline
    Maximilien
    wrote on last edited by
    #1

    Using VS2019 (/std:c++20) and VS2022 I'm trying to formally document some code in header files. Most of the time, adding comments does not seem to work properly in Intellisense. What is the proper C++ comment format ? [This](https://docs.microsoft.com/en-us/cpp/build/reference/xml-documentation-visual-cpp?redirectedfrom=MSDN&view=msvc-170) is mostly used to generate offline documentation (as far as I can see) and does not plays well with intellisense. Seems sometimes intellisense breaks down and does not fully display or does not format the comments in the info tooltips. For example : sometimes this works or not:

    /// Application arguments.
    struct ApplicationArguments	{};
    

    sometimes this works or not :

    /// /// Application arguments.
    /// 
    struct ApplicationArguments	{};
    

    I'm kind of baffled.

    CI/CD = Continuous Impediment/Continuous Despair

    L 1 Reply Last reply
    0
    • M Maximilien

      Using VS2019 (/std:c++20) and VS2022 I'm trying to formally document some code in header files. Most of the time, adding comments does not seem to work properly in Intellisense. What is the proper C++ comment format ? [This](https://docs.microsoft.com/en-us/cpp/build/reference/xml-documentation-visual-cpp?redirectedfrom=MSDN&view=msvc-170) is mostly used to generate offline documentation (as far as I can see) and does not plays well with intellisense. Seems sometimes intellisense breaks down and does not fully display or does not format the comments in the info tooltips. For example : sometimes this works or not:

      /// Application arguments.
      struct ApplicationArguments	{};
      

      sometimes this works or not :

      /// /// Application arguments.
      /// 
      struct ApplicationArguments	{};
      

      I'm kind of baffled.

      CI/CD = Continuous Impediment/Continuous Despair

      L Offline
      L Offline
      Lost User
      wrote on last edited by
      #2

      That is the format I use and it seems to work fine. However, I have noticed with some of the system functions that a double slash works as well.

      1 Reply Last reply
      0
      Reply
      • Reply as topic
      Log in to reply
      • Oldest to Newest
      • Newest to Oldest
      • Most Votes


      • Login

      • Don't have an account? Register

      • Login or register to search.
      • First post
        Last post
      0
      • Categories
      • Recent
      • Tags
      • Popular
      • World
      • Users
      • Groups