using Visual Studio object browser for descriptions of objects, methods ect

[Anonymous]

My background is Matlab, VBA and Python but I have only used C++ a little. I am attempting to learn C# for the AutoCAD API and just because it seems fun.

I have used the developers manual for finding out what functions do but it is tedious to go back and forth. I looked in the object browser of Visual Studio and I feel like I can navigate around well but when I look at an attribute, method etc, it does not bring up a description of what it does. Python Jupiter has the shift-tab shortcut for attributes and descriptions. Is there something like that for AutoCAD libraries?

[ActivistInvestor · Accepted solution]

Unfortunately, the AutoCAD managed API does not include xml documentation, which is what Visual Studio uses to display documentation in tooltips when you hover over a code element in the editor. You will see that for .NET objects and members, but not for AutoCAD API objects, because there is no XML documentation.

The help (offline or online) is really the only resource, and the help for the managed API is not as comprehensive as the docs for the native C++ API, so you should use both, to ensure you're getting the whole picture.

[_gile · Accepted solution]

Hi,

You can have some XML documentation displayed in Visual Studio (not all classes are documented) for AutoCAD 2015 and later.

From this page:

      Member and parameter descriptions from the Managed .NET Reference Guide can be displayed within the
      Microsoft Visual Studio environment as part of the Intellisense feature set. This allows for some          
      basic  information  about a member or parameter to be displayed in a tooltip while working in a code
      editor window or to be accessed from the Object Browser without the need to open the Help Viewer.
      Download the appropriate file below and extract the XML files into the Inc folder of the ObjectARX SDK.

• AutoCAD 2018 (Files are now installed with the ObjectARX SDK)
• AutoCAD 2017
• AutoCAD 2016
• AutoCAD 2015