Does anyone know if there exists a Visual Studio(2010) addin/plugin that can help with managing xml documentation comments ?
Features I'm looking for:
being able to hide/show xml comments in the code (scrolling through it makes me want to hit my laptop with a hammer)
some GUI for editing those comments and an indicator which methods/classes are already documented - like an icon/color change/sth
make it easy to build documentation eg. html/pdf/...
anything else that can help
I'm not sure if this question fits on Stackoverflow, but I wasn't able to find a more suitable Stackexchange site for this and since questions can be moved between sites please move it if it's not in the right place.
I use GhostDoc to help write the comments and SandCastle (w/ Sandcastle Help File Builder as the GUI frontend) to generate html documents from the xml comments.
Related
Dear Fellow Asciidoc/VSCode users!
I've recently switched to Windows from Linux. It is true I have not updated my Linux VSCode or any extensions for a few years now, because it worked as I wanted and didn't want any new features to brick anything. So, my issue might not be os-release-related, but rather version-related.
In .adoc files, I cannot seem to be able to enable word/snippet suggestions. Some code suggestions work, but not my snippets and simple text suggestions from one or more currently opened files. This worked on my old setup.
Enabling suggestions with editor.wordBasedSuggestions, editor.suggest.showWords: true, editor.snippetSuggestions, or the other related settings options I was able to find does nothing, even after reloading the editor.
Suggestions work normally in .txt and .py files for example.
While I didn't find anything online on how to enable suggestions, I did find a lot of posts where people wanted to disable word suggesting and also failing to do so using the above-noted settings options.
I must be missing something. Could it be a language-configuration issue? I couldn't find any relevant settings here: Language Configuration Guide.
Could it be related to something else in the AsciiDoc language extension?
Any ideas? Thanks a lot.
Basically the problem is that I'm starting doing somme development of Visual Studio 2010 extensions and language definitions are rather complex, so anyone giving a small intro and pointing some good docs would be great
Thanks in advance,
EDIT My basic problem is that I want to define a simple language to create some models on Visual Studio 2k10 and generate some source code using such models. The problem is where can I find some nice books, or do I have to dig into MSDN to unveil the mask... :)
Again, thanks
Have you tried starting with the documentation here? If you found this difficult to start with, how could we make it easier to follow?
We have a very old application dating back to ASP era which we are gradually refactoring to ASP.NET + VB.NET codebase.
It contains a lots of files with the below types:
aspx, asmx, ascx, vb, js (JavaScript), html, vbs (VBScript).
The backend database is SQL Server 2005 with lots of sprocs.
We would like to create a code documentation automatically generated from the comments in the code files. I liked Doxygen very much but seems like it does not support the above technologies. Can you please suggest some document generator tools, preferably a single tool or a group of tools?
Thanks a lot.
Ajit.
You can take a look at Microsoft's Sandcastle tool. I've used it many times, and it generates documentation based on the comments provided in your .NET code. If I remember correctly, it can also generate documentation for JavaScript libraries.
There are some out there:
SandCastle
NDOC
i've used SandCastle and it works too good if you have xml comments in your code.
You first enable xml documentation in your project by setting it in Project Properties -> Compile -> Generate XML Documentation.
Once done you may have to set treat warnings as errors, so that the studio can point out to you where and all the XML comments are missing.
To add an XML Comment, you place your cursor before a class definition or a function definition and type
///
This will automatically generate xml tags for documentation and then once you are done, you can import the project and start to build the documentation.
The good part is, if you have documented your classes well, when you use those functions in your application upon mouse over you can find the description which you wrote, much like how intellisense documentation works.
Let me know if you run into any other issues.
My last suggestion, make a hello world project and xml document it and get used to sandcastle with it.
For months now I've been trying to find a code syntax formatting extension that works for BlogEngine.Net. I'm not fond of the behavior of the default formatting extension, and have tried a couple of others (manoli is among them), but they always seem to interact badly with the TinyMCE editor. Does anyone know of an extension that works, or a different approach that will allow me to make code samples pretty on my blog without hacking the crap out of the HTML myself?
Thanks.
I would try using Windows Live Writer along w/ the Paste From Visual Studio plugin. One you go WLW, you'll never go back to that damn TinyMCE interface.
WLW here:
http://get.live.com/writer/overview
Plugin here:
http://gallery.live.com/liveItemDetail.aspx?li=d8835a5e-28da-4242-82eb-e1a006b083b9&l=8
Thanks, Rafe. Thanks to this post that Hanselman put up the day after I asked the question, I downloaded WLW and am now using it. As far as getting prettily formatted code, I'm using cut-and-paste from a little tool developed and available on manoli.net.
Check out SyntaxHighlighter.. Works excellent. For easy integration into BlogEngine have a look at my blog post.
Is there an easy way to produce MSDN-style documentation from the Visual Studio XML output?
I'm not patient enough to set up a good xslt for it because I know I'm not the first person to cross this bridge.
Also, I tried setting up sandcastle recently, but it really made my eyes cross. Either I was missing something important in the process or it is just way too involved.
I know somebody out there has a really nice dead-simple solution.
I'm reiterating here because I think my formatting made that paragraph non-inviting to read:
I gave sandcastle a try but had a really hard time getting it set up.
What I really have in mind is something much simpler.
That is, unless I just don't understand the sandcastle process. It seemed like an awful lot of extra baggage to me just to produce something nice for the testers to work with.
You're looking for Sandcastle
Project Page: Sandcastle Releases
Blog: Sandcastle Blog
NDoc Code Documentation Generator for .NET used to be the tool of choice, but support has all but stopped.
Have a look at Sandcastle, which does exactly that. It's also one of the more simpler solutions out there, and it's more or less the tool of choice, so in the long run, maybe we could help you to set up Sandcastle if you specify what issues you encountered during setup?
You should also use the Sandcastle Help File Builder. It provides you with a ndoc like GUI for generating help files so you don't have to do anything from a command prompt.
Welcome to the Sandcastle Help File Builder Project
I've just set up Sandcastle again. Try installing it (the May 2008 release) and search for SandcastleGui.exe or something similar (it's in the examples folder or so).
Click Add Assembly and add your Assembly or Assemblies, add any .xml Documentation files (the ones generated by the compiler if you enabled that option) and then Build.
It will take some time, but the result will be worth the effort. It will actually look up stuff from MSDN, so your resulting documentation will also have the Class Inheritance all the way down to System.Object with links to MSDN and stuff.
Sandcastle seems a bit complicated at first, especially when you want to use it in an automated build, but I am absolutely sure it will be worth the effort.
Also have a look at Sandcastle Help File Builder, this is a somewhat more advanced GUI for it.
Follow this simple 5 step article and you are pretty much done. As a bonus you can use H2Viewer to view Html Help 2.x files.
I use NDoc3