there are tools (SandCastle?) that can generate an MSDN-like documentation (HTML files) from your source code by using the XML comments above members. I am looking to generate a similar documentation (bunch of HTML files that one can link through), except not from XML comments but completely manually.It is for a custom scripting language, I have to document the available functions, and it would be great if I could do that in this common documentation style. Since there are no XML comments to generate the documentation from (the documentation is for the scripting language itself, not for my source code of the scripting language?
What I'm looking for in detail is a way to generate these documentation files by simply supplying this information for each function:
- Namespace (just the name and maybe a description)
- Function name + description + return type
- List of arguments and their types
from this I would to generate a document where one can first view all the Namespaces, click one (they are supposed to be links) and view all the functions in that namespace. Then you can click on a function name and view its description and list of arguments for that function.In other words: just like these automatic tools do, except now I want to supply this information manually.
While writing this I thought of one way that I might be able to do it: just create namespaces and functions in actual VB code (corresponding to the scripting language functions) and generate the documentation from that, but
1) That seems a little contrived especially if a better tool is available,
2) I would be in trouble with the types of functions and arguments, since they would have to be .NET types and not the types that my scripting language supports.
The regularity and frequency of that extolling is an indication of how many people, for whatever reason, don't use the documentation. Some say that I've forgotten what it's like to be a beginner, but I remember using the MSDN documentation as a beginner. I remember that I couldn't always find what I needed and I also remember that I didn't always understand what I found. More importantly, I remember that that didn't stop me using it first every time I had an issue and I also remember getting better at using it over time. So, I'm genuinely interested to know, if you don't use the MSDN documentation?
I have Single VB Class inside website project and I need to generate XML Documentation for this class. is there any tool that can generate this documentation?
When in VS 2008 if a developer hits the ''' it generates the XML comment tags for you, but this only works when the project setting for "Generate XML documentation file" is checked. Is there a way to tell VS to generate the XML Comment tags, regardless of the project setting? I think it is possible that someone may want comments but not create a XML documentation file. In this case I am exceeding the current Team Settings, yet other developers don't want me to change this project setting. This forces me to flip this back before checking in the project. I have the same problem with other Project settings like "code Analysis". This is only a problem for VB.NET projects.
I get a message, "The MSDN collection does not exist. reinstall MSDN." When I try to access any of the HELP features of Visual Basic 6.0. I do not have an install disc for this. Is there a download or a place I can get this?
I just recently installed VB 6.0, and I went to install MSDN Library (April 2000 Release of the MSDN Library)afterward. I was missing CD 2, but installed the other 2 CDs. It appears CD2 is the primary one for VB. Do you know how I can get this specific CD --OR-- can I just download a newer version (i have been looking for both on MSDN with no luck)?
MSDN online looks completely different. It used to be a set of collapsible controls. Does it still contain the same content? Is it under construction due to the release of 2010?
if you are a constant answerer here on msdn, and do not have a unique signature, or no signature at all, please take a little time to create one... eason ..when quoting a post of a member, if no signature available, then it would have to be followed w/ "quoted from so and so's post", this so so said this, etc.
I'm using VS2008 with all updates current. When programming with VB, I set the MSDN Help language to Visual Basic, but I very frequently get results for C#. Why does that happen and is there a reliable way to prevent it? I know C# and can adapt the results to suit my needs, but I thought using the filters was supposed to restrict results. Apparently, it doesn't. I'm just curious; why does that happen?
I am trying to use xml documentation tool in my application. one of my methods receives 'ParamArray' as an argument. i want to document this argument elements.
here is my code Public Sub LoadSearch_ByEmployee(ByVal EmployeeID As Integer _ , ByVal FromDate As Date _
I have written up troubleshooting documents for my project and would like them included in my program. I remember in VB6 there was a very easy way to do this with a control, where it already has the help document tree set up on the left and you just set it to point to certain files.
Does something like this exist for .NET? I am aware of the HelpProvider control but as far as I know this just puts in tooltips and opens documents on a button press?
I have dowiloaded vb 2008 express and cannot find the msdn image library. I go to where the intellisense tells me to go and the image folder is empty. Is there a way to download the appropriate library.
The MSDN page for this method says this: ArgumentOutOfRangeException. index is less than zero.-or-index is equal to or greater than Count. That doesn't make any sense, surely it should be "index is equal to or greater than (Count - 1)" Since index is zero based. I need to know since I'm Overriding the RemoveItem method for a Class that Inherits Collection(Of T).
With all new technologies like Async/Await I spent hours rewriting sample code from the published C# MSDN Articles to VB.NET.Now that Roslyn is available, why do the authors not inlude the VB.NET code. After all, it can be converted automatically. Why does MSFT not make this a requirement fo all published MSDN articles.This would save us VB.NETs lots of precious time.
Recently I had to reinstall my system, but now I have a new problem. VS2005 installed ok, and the MSDN documentation appeared to as well (in fact, I have 1.65 Gb of help files in my c:Program FilesMSDN folder.But VS doesn't see the files. All I get is a minimal set of help files for explaining the Help system. Also, when I search for "Visual Studio 2005 Combined Help Collection Manager" , I only get a brief description of the Collection Manager and the message "Collections available for inclusion in VSCC:" at the bottom with no collections visible, and the "Update VSCC" button is grayed out. I have tried installing MSDN via the VS2005 install disk, and separately from the MSDN disk. The version of MSDN2005 is April 2005.
im tring to switch to vb.net i guess thats the only way im going to learn how to make phone apps.when i bought vb6 i thought ms would send all the books involved , maybe in pdf formate.
For some reason, the next code found on MSDN crashes or exits after 30 cycles or, in other words, after processing 30th Property, exits without explanation. As I said, I found it in MSDN
I am simply searching how to obtain errors/warning for each function/member that isnt documented. Im pretty sure I managed to do this on one of my projects, but cant find how to do it here on my workstation. I have looked into the project props, the solution props, but cant find it. I must have missed something, or maybe I could do this at home with an extension.
I was wondering what options i have in order for me to create documentation for the applications i write? i.e. Some documentation for code written and some general comments on what the application is doing etc?
After a quick search i noticed a few options but most seem to be using VS 2003 (prefer something for 2010)
