My question is rather simple. I have a project using a few external libraries documented with doxygen.
Is it possible, with Visual Studio (or with the help of an extension) to view to doc associated with a class or a method by clicking on it or via a keyboard shortcut, all without leaving Visual Studio?
I've stumbled across Doxygen Browser Add-in for Visual Studio, which looks quite good. Compatible with most currently used Visual Studio versions.
Other than that, there's a more DIY solution avaialble by (apparently quickly) writing up a Visual Studio extension, as described here.
Related
I have created a Xamarin.Forms application on a Mac, and I understand that there's a way to generate the methods and classes documentation into HTML. But most of the tools mentioned online do not seem to work on Visual Studio for macOS.
I've tried the recommended eVisual Studio Extensions MacOS version of Visual Studio does not seem to be able to implement Visual Studio extensions ( .vsix files).
Is there a way to generate documentation in Visual Studio?
Or do I have to move the project to a Windows machine with Visual Studio to Generate the docs?
There are a number of cross-platform html generation tools that support the XML document schema that MSBuild produces via:
globally in a solution via GenerateDocumentationFile in a prop file
the DocumentationFile filename property in individual projects .csproj
Tools such as Doxygen, DocFX, etc.. run on Windows|macOS|Linux, but these tools, outside of Windows, are mainly cmd-line based.
The ones that I use:
https://dotnet.github.io/docfx/
http://www.doxygen.nl
Do a Google/Bing for more alternatives.
Pressing CtrlMO in a c# file collapses all members of all classes in the file but not classes or namespaces.
Pressing same keys in a typescript collapses all outlines even the namespaces and classes.
How can I get same behavior for collapsing a typescript file like a c# file?
Is there any shortcut or a visual studio extension to achieve my goal?
Is this behavior become default behavior in earlier versions of visual studio?
Is this behavior become default behavior in earlier versions of visual studio?
I just checked visual studio 2015 and visual studio 2017 and this is now defalt behavior of visual studio when pressing CtrlMO
Is there any shortcut or a visual studio extension to achieve my goal?
As the newer versions of visual studio have the feature out of the box and older versions are going to be abandoned I don't think there is/would be any shortcut or extension for the this propose.
I should try to convince our company to migrate to newer version of VS or spend some of my time to write such an extension.
We are using a commercial software that has its own scripting language with which you can customize the product. It is very tedious to write code in it without any help from an IDE and it has its own compiler.
Is it possible to use Visual Studio and create an environment for me to write scripts in this language and get the help of intellisense and syntax highlightning and other good things you find in an IDE? Ideally I would like to bind a button in VS to launch the external compiler and compile the code so I don't have to switch windows all the time as well.
If this is possible is it a very hard thing to accomplish?
Yes, this is certainly possible. You need to create a Visual Studio Shell add-in with custom language services and text editors. You need to install the appropriate Visual Studio SDK and then you'd continue to:
Create a custom Editor and/or designer
Add a language service
Add Project and Item templates
You're allowed to ship Visual Studio Isolated Shell with your application (license required and there are some limitations) so that your users don't need to have Visual Studio Professional installed.
There are a number of open-source projects that provide a custom editor, language services etc in Visual Studio, these could provide a nice place to research how things are done, next to teh Visual Studio SDK documentation:
PyTools, which is a Visual Studio editor for IronPython
Phalanger, which contains a Visual Studio editor for PHP
PoShTools, a Visual Studio service for PowerShell editing right inside Visual Studio
You'll probably want to dig into MsBuild as well, since Visual Studio will expect you to create a project file if you want to edit a collection of files and compile them. MsBuild could in turn call your own compiler, like it calls csc to compile C# code for example.
Creating Project Types
This is easily one of the most annoying "features" of Visual Studio in its history and I don't understand why it exists -- ever.
Why would a CodePlex project need to care what version of Visual Studio I am using?
Off the top of my head, the only thing I can think of is that some versions of Visual Studio might introspect assemblies searching for attributes to determine what to display in "Visual Designers" and "Property Editors". But why would that cause Visual Studio to not be able to open the project and allow me to browse its contents and compile?
It seems to me like Open Source in .NET is somewhat limited by the stupid dependency management exhibited by Visual Studio. In other words, if I am using Visual Studio 2008 and you are using Visual Studio 2010, then we have different solution files.
http://blogs.msdn.com/b/visualstudio/archive/2010/03/15/why-does-visual-studio-2010-convert-my-projects.aspx
Here's an example from the site as to why Visual Studio converts your projects to 2010 format.
For instance, Visual Studio runs
custom tools such as single file
generators for designers in order to
output code representing the changes
made to the designer. Many of these
custom tools are upgraded or
completely replaced in the newer IDE.
During conversion, the IDE knows which
custom tools to replace or upgrade. In
order to make round-tripping work, VS
would need old and new custom tools to
understand each other so as to ensure
that old and new designers can work
side by side. Other than designers,
the following files would also be
affected: resource editors, wizards,
code snippets, item and project
templates, diagramming and modeling
tools, and many more.tools, and many more.
Since 2010 knows about what tools 2008 has, it can convert forward to be compatible with the custom tools 2010 uses. 2008 has no idea about what 2010 is using, how could it? Therefore, it is impossible to convert backwards since it doesn't know what it needs to convert, nor how to.
I believe the purpose of this touches on what you stated in your comments. If you are using 2008 and I 2010 and I compile it, how could you possibly run it again? 2010 is backwards compatible but 2008 has no way to make itself forward compatible.
Thus, by recompiling the project in 2010 I ensure that no 2008 user may mistakenly think they can compile it.
Preferably a site that has macros searchable by Visual Studio version.
Well, the web's top Visual Studio project site is http://www.codeproject.com. You'll find lots of macros there.
Specifically, check http://www.codeproject.com/KB/macros/
I think there is no specific search for Studio versions, but each macro in there carry its own compatibility specification.