.NET Project Coding Documentation?
May 25, 2010I 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 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 RepliesI am creating a dll to use with all my projects and have run into a problem. functions work fine and i have no problems using the dll with a project but i am trying to add xml documentation to the functions in the dll so that i have information when i call it, i can see the summary if i call the function from within the dll project but not if i call it from a seperate project.
View 2 RepliesHow to write Technical Documentation for a project flow
View 1 RepliesI 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?
View 1 RepliesI've just picked up a project from someone who has recently left our company, and the project file for the project has somehow had XML documentation deactivated. Typing ''' no longer automatically creates XML documentation segments, and existing XML documentation within the code does not show up in Intellisense, and is also not correctly highlighted as XML documentation.
In addition, the Intellisense for the My. namespace contains only MySettings, Resources and Setting under the "All" tab. Everything else is missing. Attempting to manually write My. namespace code results in compile errors. These are not problems with the IDE; I can start a new project and both Intellisense and My. work fine in these new projects. I can only assume that this is something which has been set on the project itself.
I have been writing code fore a rather large project in the past mounts And Im beginning to think about arcitecture of the program... Its just a complete mess. I dont know how to tackle so much code..Its beginning to be impossible to debug.Basically Im doing the following prosidures. Importing several a Excel files and getting the rfrequency data from these files..Displaying them in a litview and a datatable... so you are able to edit them..Doing some calculation and exporting the results back to a xls file.Problem is now that im going to add more functionallity to the program,. What im woundering about is, is there some good unofficial guides on how to program with OOP?
View 11 RepliesI am making a application to help manage your files and notes on different projects, you can organize your notes, images and videos, However i am stuck on what coding to use to manage the project, what my.settings etc.
View 2 RepliesI have just started coding my Computing project for my A-Level, and I will admit, I am far more experienced in VB6 than VB.NET (as embarrassing as that is to say).I get extra marks for making everything presentable, so was wondering if it was possible to add icons into .NET buttons. For example if I have a button to add an entry to the database, I want a nice Web 2.0 looking icon (for which I already have) next to the text on that button.
View 1 RepliesI am coding an asset management system for telecom as my major project.It features submitting asset information,retrieving an asset information by entering the id of the user responsible for it,checking the number of live,stock and scrap assets and downloading it in an excel file and updating any asset information if needed.It has an admin login to it and even a change password form.
View 2 RepliesI am about to commence coding (actually recoding) on a project that accesses 100 tables of a database, more to added at later time. About half of the accesses are queries with joins and unions. I am more of a coder to not use wizards such tableAdapter, but code more by other methods. I have read some post of this site that suggest avoiding tableAdapters, not to use them in an Enterprise environmentl, but no reasons. I would like to hear from willing to bend my ear, pro or con.
View 1 RepliesSay we have a DataGridView on the main form. I can chose to establish its properties by code or by selecting them in the Properties panel. Is there a difference between these two techniques, a loading time penalty in any of the cases especially?
View 5 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 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 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 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'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.