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?
Related
I've scoured around and haven't been able to find any kind of a decent reference guide on Visual Studio property sheets. Most of what you can do with them cannot be done through the UI, so I've got to think there is a reference guide somewhere that can be useful in understanding the available fields, syntax, etc.
Lunicon's answer to this question was really useful, but I'd really like to know where the information on what could be done in property sheets came from. I'm hoping it was not a lot of trial and error. ;)
This is not a decent reference guide at all, but I did notice that there is a schema for the property sheet defined here: http://msdn.microsoft.com/en-us/library/ak4435es(v=vs.80).aspx
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.
I want to start writing T4 templates. I've heard a lot of great a things about these templates (in the Hanselminutes podcast mainly) and would like to know more. What are the best locations to look for info on T4 template writing? What do I need to get started implementing my own templates? Are there pitfalls or important things I should know?
I wrote a little post on this with some pointers to other posts:
Tip 3- How to get started with T4 templates
You also might want to check out David Ebbo's blog he has been doing some pretty cool things with T4.
Oleg Sych's blog has a very useful intro.
Hope this helps
Alex
You have to have an editor. Without the syntax highlighting, figuring out which is generated code and which is generator code is an exercise in futility. Here's another editor addin that's free: http://t4-editor.tangible-engineering.com/T4-Editor-Visual-T4-Editing.html
I download this. After I watched this.
Does anybody use the Class Designer much in Visual Studio?
I have downloaded the Modeling Power Toys for 2005 and have been impressed with what I've seen so far. The MSDN Class Designer Blog doesn't seem to have been updated for a while but it still looks quite useful.
Is the Class Designer a quick way to build the basic application or should I just work out on paper and then start coding?
Thanks
As a visualization tool, or for exploratory purposes (drawing up multiple options to see what they look like) it's not bad, but generally I find the object browser does fine for most stuff I care about.
As a code generation tool, it's a terrible idea.
The whole idea that we will design all our code structure first, then fill in the blanks with small bits of implementation is fundamentally broken.
The only time you actually know what the code structure should look like, is if you've done the exact same thing before - however then you can just use your previous code, and you don't need to draw up any new code in any kind of designer.
If you decide ahead of time to use a particular class structure before you've actually tried to solve the problem, there is a 100% chance that you will pick the wrong design, and shoot yourself in the foot.
Short answer: No.
Longer answer: No, not at all. There's a reason it hasn't been updated.
[EDIT] # MrBrutal - Sorry - do you mean to generate code or just represent a design? Because I took your question as to generate code for you.
I guess this is old, but I use it a lot. It could definitely be improved, but I find it extremely useful to be able to visualize my class structure, and to be able to jump to a specific class or method by clicking on it visually.
It's also slightly easier to add classes/interfaces with than the solution explorer, although the new files always end up in the root folder, instead of the same folder as the CD.
The main benefit I find is to be able to see a group of closely related classes at once. I think the best approach might be to have a single CD for each code folder/namespace.
I've used it a couple of times to get some decent looking class diagrams to put in presentations/blogposts etc. But thats about it...
Any suggestions on other simple UML/class diagram tools that is easy to use and create some nice looking diagrams? Must be able to generate diagrams from .NET code.
I have tried it out couple of times, mainly for viewing existing classes.
If it would show all the relationships, it would be more usefull. Now it only shows inheritation.
I find it useful sometimes, more often for documentation afterwards.
It's a new little utility, but I don't think you get the full functionality in VS Pro - I think you need Architect's Edition.
The comments here suggest that few people find the class designer useful.
Amusing to note that Microsoft designed the class designer to be a useful replacement to useless UML (UML diagrams being untrustworthy once they lose synchronisation with source code).
The trouble with class diagrams is that they tell us what we already know.
I only use the class designer to display my existing classes, but I don't use it the other way, e.g., design your classes there then let it generate the code.
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