function in visual studio to create documentation similar to javadocs? - c#

Is there a easy way to create documentation pages based on xml documentation in visual studio 2010/c# like there is in ecplipse/java javadocs?

No.
You'll have to use external plugin/or application. I use doxygen.
Sandcastle is another choice. There are some others - search the SO history.

Sandcastle is one such option

Check out Doxygen. It creates javadoc style HTML documentation.

Sure. XML Code Commenting http://msdn.microsoft.com/en-us/magazine/cc302121.aspx createds the XML comments.
There are several tools out there to turn those into nice looking pages via xslt. A quick bing search brings up a bunch: http://www.bing.com/search?q=XML+code+comments+xslt&form=CMDTDF&pc=CMDTDF&src=IE-SearchBox

Related

c#-doc-viewer for VisualStudio

c# offers a nice way to document your c#-code. But I don´t find any nice viewer. I search something like the java-doc-viewer in eclipse. This viewer allows you to browse in the java-doc just by moving your mouse over eg. a class-name.
Does someone know a good extension for Visual Studio 2010 that contains such a viewer?
I have the "Productivity Power Tools"-Extension installed. But it hasn´t a real doc-viewer either.
Edit:
Here is a picture of what I search:
And this is the best I can find for VisualStudio:
You try using CR_Documentor, if you don't mind installing Code Rush (alone for that purpose; you only need the free "DXCore" actually, checkout the project's homepage for more information).
Note that this tool doesn't require a prior generation of the documentation using tools like Sandcastle. It works by simply placing your cursor in a API comment block, e.g. that of a method.
Obviously, this has some drawbacks, for example, links to other items (e.g. <see/> or <seealso> will be rendered as a link, but don't work as such).
This is what it looks like:
I was using it once, way back when it was still maintained by the original author Lutz Roeder, and it did it's job well. I have not been using it since.
Update: You could also use ReSharper, which provides a "Quick Documentation" feature.
There isn't any built-in tool in VS for viewing the documentation of your code. You have to generate the documentation pages from the XML doc, using external tools.
Free tools:
Sandcastle is the most well known, it has a lot of features, but it doesn't seem to be maintained any more and it's quite difficult to use (although Sandcastle Help File Builder makes it significantly easier, and is still maintained).
docu is simpler to use, but not specific to .NET
Monodoc (from the Mono project)
Commercial tools:
VSdocman
Document! X
Doc-O-Matic
ForgeDoc: this one is quite new and looks very promising: very lightweight, simple to use, fast, good-looking output... It's also much cheaper than the others above
You can use NDoc to build the API documentation and generate help files (typically HTML files)
http://sourceforge.net/projects/ndoc/

Adding a tool bar to a web page

I want to add a tool bar (just like the one above the text area where we type our questions in this forum , with bold,italic etc) to a web page.Is there an easier way of doing this?I am using ASP.Net c# and VS2008.
Thankx in advance.
Here is one of the well known ones.
http://ckeditor.com/
There are a bunch. The "most famous" is tinyMCE, but there is also CKEditor. If you need an highly customizable solution, you could also try Wysihat.
there is so many WYSWING editor (open source and commercial) In most of my cases CKEditor was the best option . it is opensource and fully customizable

What's best way to format C# in WordPress?

Hey bloggers out there! I've created Wordpress blog that I am hosting myself, and I'm having the hardest time figuring out the best way to add C# snippets to my blog. What do you all use?
I'm currently using the "SyntaxHighlighter Evolved" plugin, and it works great for the most part - the only problem is that switching back to the Visual Editor removes all of the whitsepace padding. I've tried wrapping the [sourcecode] tags in <pre>'s, but then the formatter doesn't work correctly.
Any help would be much appreciated. I've spent about 10 hours trying to come up with a robust solution, and no luck.
Cheers!
See the blog post that I wrote on this exact question, which explains how to use SyntaxHighlighter and fix TinyMCE so that it doesn't mess up your white space or tags (you can either customize one of the tinymce files in Wordpress, or use a plugin to do it for you).
Use the WP-Syntax plugin. To use it, you wrap the code with a pre tag with a language attribute. Consolidates the effort.
If Client-Side (JavaScript) Syntax Highlighting is also an option, I can recommend google-code-prettify, which works quite well. Only a little Code escaping is needed to make it zero-friction for me as an author, as I detailed in a posting.
You can use Windows Live Writer to write post for your blog and use Steve Dunns live writer plugin.

C# XML language file

I want to have my ASP C# application to be multi-language. I was planned to do this with a XML file. The thing is, i don't have any experience with this. I mean how, do i start? Is it a good idea to store the languages in an xml file? And how in the code do i set the values for ie my menu buttons? I'd like to work with XML because i never worked before with XML, i want to learn how to deal with cases like this.
You want to look into RESX resource files. These are XML files that can contain texts (and images) and they have standardized handling of localization/translations.
Support for this is built right into ASP.NET. There is a guide for how to use it and set it up at: http://msdn.microsoft.com/en-us/library/fw69ke6f(VS.80).aspx.
The walkthough is pretty detailed and should help you to understand the concepts. My preferred is method described a bit down in the document in the section "Explicit Localization with ASP.NET". Using this you will get a set of XML files with your texts and translations in a fully standardized format.
Do you know about the .Net From automatic translatation (based on .resx) resources ?
You're in luck, this sort of stuff is built directly into .Net
The way it's done is that for every page you have a language specific resx file.
eg
Homepage.aspx
Homepage.aspx.cs
Homepage.aspx.en.resx
Homepage.aspx.fr.resx
you simply dynamically figure out what resource file to use, and all the appropriate labels come through in French for example.
Helpful Tutorials and Videos
A Simple Example
Good luck.
If internationalization in .net is something you want to get into seriously, you might want to consider this
(and no - I have no stake in it)

C# syntax highlighter for blogging on BlogSpot

I'm looking for a syntax highlighter cum code formatter for my blog on BlogSpot. I've tried several today, but the all want to include <style> tags, or reference a stylesheet. I'm looking for one that is ideal for segments of code, and includes styling inline. Any suggestions?
The project referenced above has moved:
http://alexgorbatchev.com/wiki/SyntaxHighlighter
Instructions for using it on Blogger:
mlawire.blogspot.com/2009/07/blogger-syntax-highlighting.html
You can always copy the extra few bytes of styling for, say, a Pygments highlighter (which really is quite excellent) into the <head> of your blog. You don't even need to install any software; just copy the HTML from the online service.
I've created a Free Online C# Syntax Highlighter that has exactly the ability you need - to inline the needed CSS styles. All you have to do is to select the "Inlined styles" check box, paste your C# code and click the Colorize button. You can find it on my blog.
Try this one: http://code.google.com/p/syntaxhighlighter/
I use SyntaxHighlighter Javascript Library. It's really easy to add and use.
here's more information on it that might help others out:
http://www.craftyfella.com/2010/01/syntax-highlighting-with-blogger-engine.html
I had this exact problem.
I wrote an image formatter for Pygments (included in the core distribution).
Please don't hate me for such an abomination, but yes, it renders the highlighted code as a png or jpg or whatever you want. So it has no external dependencies etc.
pygmentize -f png -o mysource.png mysource.cs
I try to make sure that I always link a plain text version of the source for people copy-pasting.

Categories