IDE :: Function Description(documentation) Not Working In .NET?
Sep 28, 2009
How is it possible to add a function description in VB.NET (VS 2005)? in C# this task is resumed to tape 3 times the "/" simbol just above the function declaration. (generates the <summary> tag and others)
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.
One 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.
I just downloaded the trial for this application and it doesn't seem to work. I went through the Quick Setup guide and it all looked great. Now when I place my cursor on a member of any type and press Ctrl+Shift+D it does nothing. I placed it on top, inside, etc... Nothing. If I press Ctrl+Shift+A (twice) on top of the member it tells me to place it "in the line of the form MyType myVariable;". I'm not quite sure what this means unless it's referring to C# but this project is VB.NET which it doesn't seem to recognize. Anyone else have this issue? I was hoping it would make things easier since I've read that it can document an entire document rather than having to member by member. Using VS 2010 Premium.
I 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.
Since I've been writing my prgram, I felt the need to provide documentation in much the same way VS2010 does.I've searched everywhere I could, but all the references I could find where for older versions of the IDE.It appears there is no builtin facility to produce documentation and this sounds silly to me.I found external programs, but at 300$ a licence it's way over the top of my budget.Even the hints and tips stickied on this forum are out of date, as they refer to VS2005.So how should I produce inline documentation for my classes
I'm writing a VB.NET function with a ton of overloads. I've seen that most .NET functions have parameter descriptions in IntelliSense. For example, when typing in String.Compare(, IntelliSense says Compares two specified System.String objects and returns... you get the idea. This description changes and you click through different overloaded versions of the same functions. When you start typing in something for a parameter, it describes the parameter you're currently inputting as well. Example: strA: The first string to compare..
It is really too bad that Microsoft (who once had the best documentation in the business) has slipped so badly. Good documentation does not really require analysis, though, admittedly, it is a lot of work. To wit: for each and every single method, function, event and operator provide the following: a brief topical functional description including any parameters, a detailed description of how the object works, a workable example of the code needed to make this object do something useful and links to all possible associated objects (See Also).
I see pages upon pages of useless text and links to other pages full of links. This rapidly descends into a crevace of unbelievable complexity for the developer trying to find out something truly simple like filtering a DataGridView without changing the data connection. (As it turns out this is very simple to do but I could not find a single example of how to do it in the Visual Studio documentation.)
I'm developing a system and the system contains an update function to update the DB. I have performed all the coding but have some minor problem in my SQL Statement and I'm unable to detect the SQL Statement Error. Hope someone could rectify the problem.
file.Exists function not working Dim f1 As New FileInfo(Server.MapPath("/CaseStudyImages/TemporaryImages/")) Dim f2 As New FileInfo(Server.MapPath("/CaseStudyImages/" & success & "/"))
I'm using fileopen() function to open the file, after doing all the works I'm using fileclose() to close the file. But when I access the file again it returns already the file is opened by another process.
Sample: Dim intFile As Integer = FreeFile() FileOpen(intFile, mstrFilename, OpenMode.Binary, OpenAccess.Read, OpenShare.LockWrite) FileClose(intFile)
Loading another form increases the memory usage of the application and after closing is not combing back to normal? dispose function at formclosed event is not doing that
I have a form that displays a graph. From the appropriate toobar button click frmGraph.show is called and it works. But when I call it from the assigned F6 function key the graph hardly ever displays. Sometimes it does display properly, sometime it flickers a one time display of the graph then it's gone, but mostly the form just draws the background but no graph. In debugging this i discoverd that putting a message box just before the call to frmGraph.show the graph will display properly everytime after i click ok in the messagebox. Anyone know how to cure this or at least a workaround that doesn't involve displaying the messagebox? This is the code with the messagebox("here") just above the call.
I've been trying to get the double buffer function working in VB.NET GDI+ for a space invaders game using the following command.[code]But because I am using a separate draw routine attached to a class it doesn't seem to work:[code]The aliens draw correctly but the images are very stuttery and double buffering doesn't seem to work.
I have the following code which I want to run when the page first loads and then again when an update panel (asp.net) is run. Therefore I need to use function pageLoad() rather than document.ready.
I found the following example of how to print a root directory on the net Code: Sub Main() Dim Current As String Dim Root As String Current = Directory.getCurrentDirectory() Root = Directory.GetDirectoryRoot(Current) Root = Directory.GetDirectoryRoot("") Console.WriteLine("Current directory {0}", Current) Console.WriteLine("Root directory {0}", Root) End Sub However it just causes the error "name directory not declared"
I have an array with about 10 items in it. In order to get the desired functionality I need to append some text to each item in the array in order to sort it properly. Once it is sorted I want to remove the text I added and then just display the second half of each item in the array. The sort works great, but the split function is not worrk.
I have no clue how to get ScreenToClient working. I declared the function using: Private Declare Function ScreenToClient Lib "user32" (ByVal hwnd As Integer, ByVal lpPoint As POINTAPI) As Integer Then: Private Structure POINTAPI Dim x As Integer Dim y As Integer End Structure [Code] ..... What I want to do is move the cursor to 29,109 of the hwnd, not my screen (hence why I'm trying to use screentoclient).
I'm working on a spider bot and hit a snag in the last function?'This function navigates the web browser control to the entered URL.'It wait till the document is loaded completely into the browser control by testing the ready state of the web browser control. 'Then it returns the web browser document.
Private Function Navigate2WebPage(ByVal URL As String, ByVal TimeoutInterv As TimeSpan) As HTMLDocument Dim T1, T2 As Date Dim Interv As TimeSpan Try
[code].....
the problem lies with "SHDocVw.tagREADYSTATE.READYSTATE_COMPLETE" I an example of it on the net and it works in the sample app but not in mine. It won't compile because it says "Name ShDocvw is not declared" and i've searched through the example app and can't find it "declared" anywhere. I had a look at the designer generated code and found
2003 - Friend WithEvents AxWebBrowser1 As AxSHDocVw.AxWebBrowser 2005 - Friend WithEvents WebBrowser1 As System.Windows.Forms.WebBrowser
what is a AxSHDocVw.AxWebBrowser? Now i've done some searching and found that apparently "SHDocVw.tagREADYSTATE.READYSTATE_COMPLETE" no longer works in 2005.
My Problem is, that I have some Buttons, Labels and TextBoxes I need to generate after the User told a number of Players. With the Code I'm using now only the last Player will have these Controls working, because they are moved - for example - from Player 1 to Player 3. how to create such a ControlArray The biggest Problem I have is, that these buttons have to have names like "1", "2", "3" and so on (or if it works somehow to read out the Index of a ControlArray the names will not be necessary).
This is the code I am using right now to generate the Controls, but as you see it won't work, because the properties will be changed when the For-Function restarts.What I need is a hint on how to get these Controls/Buttons into a Control-Array and then read out the Index-Number to use them in the Functions that are called.
Public Class Form1 Private btnTestNumButtons() As System.Windows.Forms.Button Private Sub CreateButtonArray()[code]......
Can anyone help me figure out how to get a security descriptor working with the CreateNamedPipe API function? At this moment I get Marshal error 1336 "The access control list (ACL) structure is invalid." with the CreateNamedPipe function. All of the other functions seem to be completing sucesfully and are returning proper handles.[code]
I've reviewed the other posts regarding this subject. I'm using VB from Excel and the function keys are not working. I'm running Windows Vista Home Premium with Office Ultimate 2007 Looks like Excel is running VB 6.5So, this used to work for me...I've used the debugger quite a bit. When I try the solutions suggested Tools->Options->Keyboard (after checking check-box to show all settings) when I click on the box just below "Apply the following additional keyboard scheme" the only item in the list is default. There is no selection for VB 6 or anything else for that matter.
I'm using a DO interation to loop a function I'm using to test for internet connectivity. The code is working fine, except that when one of the tests is satisfied the loop stops. I want this to continue in the background while the program is running. How can I get this to work?
Private Sub checkInternet() Dim InetChecker As Boolean InetChecker = CheckForInternetConnection() Do While LabelCount.Text <> "" Thread.Sleep(10) [Code] .....
I have a vb.net function which uses oledb to create a spreadsheet, then treat it like a database, creating tables and inserting values. The function takes in a filename and a dataset, and returns the filename if it worked. The function works beautifully on my dev machine, but not other PCs. Below is my function, is there anything wrong with the code? EDIT: There are no errors being thrown, the resulting file doesn't contain any data.
I am looping through all folders on the computer in a background worker. Starting with just the C: drive, the function works perfectly I've been tasked with adding recursiveness to this function to loop through all subfolders within each and every folder.
This is the working code without recursive. Startpath is set = "c:".
Private Sub BackgroundWorker1_DoWork(ByVal sender As Object, ByVal e As System.ComponentModel.DoWorkEventArgs) Handles BackgroundWorker1.DoWork Dim fs As New FileSystemObject Dim fsfolder As Folder Dim subfolder As Folder
[Code]...
EDIT: I was doing some testing and threw in an if check to skip the C:$ folders. Working ok so far and noticed something really strange. It doesn't loop through all the folders in the C: drive. I think it will loop through only the first 2 folders. One is C:Boot so I skip that and the other is C:Dev-cpp. It won't loop through the Program Files, Program Files (x86), or Users.
My Requirment is to Leave Blank space to the right of the each Lable (String) in Chart in SSRS.
Using Custom VB.NET Function, i want to Pass String Lable to VB.NET Function and then Function Return String with Padding Blank Space to the right of String.
Example :Lable String is : "United States of America"
My Lable output should be : "United States of America "
I have a backup / restore function working fine on Windows XP. When I deploy the application onto a Vista OS OI recieve the following error, can somebody please advise me how I can resolve this issue?
System.IO.FileLoadException: Could not load file or assembly 'Microsoft.SqlServer.Smo, Version=9.0.242.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91' or one of its dependencies. The located assembly's manifest definition does not match the assembly reference. (Exception from HRESULT: 0x80131040)