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)
I have used Visual Basic 2008 for a while now and i have never came across this problem, when i try to build my application i get the following two errors...
Quote:
Unable to copy file "objReleaseParent Pro.xml" to "binReleaseParent Pro.xml". The file or directory is corrupted and unreadable.
AND
Quote:
Unable to create XML documentation file 'E:Parent Pro - TRIALParent ProobjReleaseParent Pro.xml': System Error &H80070570&
I can run in Debug no problem, but i need to publish to a web server and i get the same problem...
what tools do you use to create programming flowchart/documentation from VB.NET source code? There are absolutely no comments/documentation at present. I am a beginner, i.e. I tried Sandcastle but it is way over my head and could not get it going, not even with GUI.Fatesoft's CodeVisual To Flowchart is OK but it is almost the same as the code and I still don't understand the code.
View 3 RepliesHere at my company we have an Access application that allows users to create documents based on invoices that are in Great Plains, an accounting program. Documents such as invoices, packing lists, export documentation, etc., etc.This application is very old and very hard to maintain so we're doing a rewrite and I've chosen this project to be my first Visual Basic .NET project.Basically what the application is going to do is allow users to do the following:
Pull up invoice information and then add some secondary information such as comments and the like Choose which documents they want to print out Open the documents and then allow the user to edit the documents That last part is the tricky part. The users right now create these documents out of Access and print to a PDF and then edit the PDF with comments that can be specific to the document and customer. If they didn't have to do that, then I could just used canned reports or something.
What I am thinking of doing is creating Word templates with text boxes and inside those text boxes adding addressable bookmarks. When the user goes to print the documents, open Word, populate the bookmarks from the database (SQL Server) and then that will let them draw text boxes and fill them with whatever they want before they print the documents and then they can save them.
Here's the code I worked out to do this (of course the final result will be much more complex):
Public Const wdPageBreak = 7
Dim oWord As Word.Application
Dim oDoc As Word.Document
[code]....
I cant find any documentation on making an API for a visual basic application. Does anyone have any ideas where I could start?
View 12 RepliesHello I want to create a windows form application program that can create games something like Gamemaker or Klik & Play (butt less advanced) with D&D "Drag and Drop" events and actions.
View 7 RepliesHow can I create a VB application in VS2008 without requiring the application be run on a computer with a .NET framework in place?
View 4 Replieshow to create a uninstall command for a Windows-based application in the Application Folder when creating a new setup project in visual studio 2008.
View 4 Replieswhere can i find some good documentation or training on how to use WMI?
View 3 RepliesI 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 _
[code].....
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?
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?
View 39 RepliesI want to know the professional way to comments VB.net project coding. In future, it may help to other people, whom may update my project.
View 4 RepliesHere's an example of a wasted day:
(1) I want to find out exactly what Binding.FormattingEnabled does.
(2) I type MSDN Binding.FormattingEnabled into google and go to the page.
(3) I read the 3, 'helpful', line description.
(4) I check out the bottom of the page for references.
(5) Never mind, non of those helped....
(6) I search google and find nobody seems to know what the property does in its entirety.
(7) I open up reflector and spend hours in a tangled web before being 70% sure I know what's going on.
(8) I carry on coding, but the 30% is niggling at me.
(9) Repeat 6 - 8 ad nauseum ...
There must be a better way!
I'm using VS.Net 2008 Express edition, btw.
ETA: The FormattingEnabled property was just an example, this is more of a general question. Using reflector, I'm about 94.314% sure of how it works..
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.
[Code]...
I am using something similar to this and it will not display the Summary or Remarks when I am attempting to use the Intellisense for this function?
[Code]...
When i perform unit testing on routines, using the unit testing framwork provided by VSTS, i need to get a output of the unit test and result on to a document (documentation). how do i do i do this?
View 1 RepliesOne of the Projects in my VB.NET Solution seemed unwilling to let me write XML Documentation in my code. When tapping ''' on the line directly above a method declaration, nothing would happen. The project consisted of modules and classes only(no forms), so I initially thought that had something to do with it.
Later I found that under project properties and the Compile tab, the "Generate XML documentation file" checkbox was left unchecked. Checking this instantly allowed me to place the comments normally. After doing some testing, I also found that Creating an Empty project leaves the checkbox unchecked, while creating a Windows Application automatically checks it.
how to call or reference an item from an xml document. I hava a java app that i'm converting over to vb.net. The java application uses the digester class to to parse the information. The app uses 2 classes and the xml file. one class is the Vb.net Parameter class (fully converted from Java to vb.net) that pulls the information out of the xml document and then places it when called into the 2nd class file.
I'm pretty sure that i need to use the system.xml class to do this however i'm having or just not reading the examples properly.
I have partially converted the code over to vb.net, it still has some java references.
[Code].....
I have been searching for the ability to utilize the three apostrophe means for auto-documentation ( ''' ) outlining but just can't find the IDE setting for such.
View 3 RepliesI am trying to add structure (line breaks, paragraphs and code) to the Remarks Tag of XML documentation in VB2005. I have tried many examples from "Recommended XML Tags for Documentation Comments (Visual Basic)" [URL], but all of the examples seem to compile to one continuous line when viewed in the VS2005 Object browser.
Below is an Example:
[Code]....
Website, Documentation but do not know how to access it. [URL] [URL]
View 1 RepliesI simply want to find documentation about invoke and begininvoke. A member of delegates. simply searching on it on bing and stuff don't show anything. It shows control.invoke, etc.In the delegate msdn entry there is no invoke member. At least not when I look for system.action or system.func.Where can I found begininvoke documentation? what will happen if I put nothing as callback function for example? Intuitively the program simply don't call any call back function but hei, I want to makes ure of it.
View 3 RepliesWhere is the regular expressions documentation?
View 4 RepliesIf I run this against a Windows 7 machine it shutdown with forcing apps to close. owever if I run the same program against a XP on it reboots the machine??? SO I tried swapping the parameters between reboot and force and this works on XP IE the supossed reboot actually forces applications to close ?? Is Microsoft documentation just wrong after all these years or am I missing something ??
[Code]...
I understand this is possible but I am not sure where to start. I want to either buy or create an application that captures a resource from another application so that I can fire off another application. In other words, I want to start an application (which I did not write) that is database driven so the form has a number of text boxes. When someone keys something into that field I want to be able to validate the value, outside of the original application. For instance, if the program asks for a zipcode and it doesn't validate the zipcode, I'd like to trap for that and write something that would validate it. At this point I don't think I'd have to send anything back to the textbox/resource.
View 1 RepliesI'm trying to implement the Bouncy Castle encryption library in a .Net project, but am not finding a lot of .Net-related documentation. The class/method structure isn't even close to the ample Java-related examples.
View 2 RepliesIs there a way to include examples for multiple languages (C# and Visual Basic, for example) in XML documentation?
I'm using SandCastle to build MSDN-style documentation and would like to include usage examples for a few .NET languages.
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.
I once was able to insert a Class-Header type XML comment section which structured the describing of a class; I now cannot remember how I did it. I think I either used a snippet or some macro-type character combination that inserted some XML documentation fields which made commenting a class well structured. It may have even been an extension.
View 3 Replies