Properly document C++ code for use in Intellisense ?
-
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
-
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