Visual Studio Documentation Should Have Examples For Every Method, Function, Event And Operator?

Dec 17, 2009

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.)

View 19 Replies


ADVERTISEMENT

C# - Add Developer Documentation To Visual Studio Projects

Mar 16, 2012

Basically, the question is: Where (and in which format) should I store textual developer documentation associated with my Visual Studio projects?

To elaborate: XML comments are great, but they don't cover all use cases. Sometimes, you'd like to describe the class architecture of the project at a high level, add usage notes to your library or just leave any other kind of message to future generations of developers working on this project.

I'd like to add these documents directly as files into the Visual Studio project, to ensure (a) that they are available to the developer without further searching and (b) they are version controlled (using the same svn/git/whatever repository as the source code).

Currently, I add a folder _Documentation to the project and use text files, but I'm not sure if this is the best solution. Visual Studio does not have an option for automatically word-wrapping text1, and manually fixing line breaks after each change is annoying. On the other hand, Word documents don't work well with version control, and TeX is too much of a hassle to set up and teach on each developer PC.

Is there a well-established best practice for this?

1 I know that there's Edit/Advanced/Word-Wrap, but this only affects the display, not the file itself.

View 3 Replies

C# - Multiple Language Examples In XML Documentation?

May 24, 2010

Is 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.

View 1 Replies

Documentation Error, Now Corrected In Visual Studio 2010. Re: Convert.ToUInt64?

Apr 6, 2010

[url]...

Documentation error, now corrected in Visual Studio 2010. Re: Convert.ToUInt64?

View 1 Replies

Use <> Operator In ScheduledAction Class (Visual Studio, Windows Phone 7.1)?

Mar 15, 2012

I need to use the "<>" (not equal to) operator for a peice of coding which uses the SheduledAction class, but I keep getting this error:

Error 1 Operator '<>' is not defined for types 'Microsoft.Phone.Scheduler.ScheduledAction' and 'Microsoft.Phone.Scheduler.ScheduledAction'

Here is my coding thats bringing up the error:

Dim hw As ScheduledAction = ScheduledActionService.Find("Hello World")
If hw <> Nothing Then
...

View 1 Replies

Turn Off Visual Studio Lines Around Each Method?

Feb 14, 2011

In Visual Studio when working in VB.Net, it automatically creates lines/regions around methods etc.

Can this be turned off somewhere in the options?

View 2 Replies

In Visual Studio 2005 No Tableadapter Update Method

Jan 11, 2011

Whenever I create a table adpater the wizard does not create and update command. It creates Select Insert and Delete but no Update command. I have a primary key in the data and have completely deleted my dataset and created connection and table adtaer from scratch with still no update command wizard says it will create it but does not.

View 5 Replies

Visual Studio 2005 - Shared Method In Cannot Handle?

Oct 22, 2009

(I tried with this question but this code isolates the problem better. I have this code:

Public Shared Sub PopulateTextFields(ByRef stuffList As List(Of Stuff))
Dim aStuff As New Stuff
For Each aStuff In stuffList
DoStuff(aStuff)
Next
End Sub

[Code]...

View 3 Replies

Does Visual Studio 2010 Support Multiline Anonymous Method

Oct 5, 2010

I found that this answer was asked and answered before VS2010 was actually released.[code]to a .NET Framework 4.0 project in Visual Studio 2010 and it does not compile.Do you now if this feature is really implemented and what I am doing wrong?

View 3 Replies

Visual Studio - Call A Keypress Method Dynamically For Each Control?

Sep 8, 2011

I working on a project that includes to call a certain type of method to each control, i have this code:

Private Sub txtBcNum1_KeyPress(ByVal sender As Object, ByVal e As System.Windows.Forms.KeyPressEventArgs) Handles txtBcNum1.KeyPress
If Char.IsDigit(e.KeyChar) Or e.KeyChar = Chr(8) Then

[Code]....

I have 15 textboxes( txtBcNum1,txtBcNum2,....,txtBcNum15 ), what's the best way to call this function inside KeyPress method on each textboxes with out manually adding it to KeyPress method?

View 1 Replies

C# - Class Name And Method Name Dropdown List Is Missing (visual Studio Setting)

Sep 17, 2009

Does anyone know how to get my class name and method name dropdown lists again? It's the dropdown lists that are usually above the code. It's just a setting but i can't seem to find it. I don't want to reset my setting btw. I shouldn't have to.

View 2 Replies

Visual Studio 2010 - Return Value Of Method. System.__Com.object?

Apr 10, 2012

I know it's a stupid question but I cannot find info about it.

Public Function TestFunc() As String

Dim lMapper = cRouter.StaticPortMappingCollection
Dim lMappedPort As NATUPNPLib.IStaticPortMapping
Dim Test As String

[Code]...

How to get this value? By my way I get *System.__ComObject*

View 1 Replies

Visual Studio 2010 - Get Forms Application Startup Method To Be Sub Main() In Program.vb?

May 17, 2010

Trying to get it to behave like C#, where there is a Program class with a static Main method.However, in the project properties, I cannot set Program.vb to be the startup object, only the forms (it is a forms application).

View 2 Replies

.net - Call A Function From A Class In Visual Studio?

Jul 19, 2011

Now to working with Visual Studio Solutions, but I am trying something very basic but no joy. So in my project I have a folder App_Code and in this I added a class called Test.vb and added a simple function

[Code]...

But in my Default.aspx page I am struggling to find the correct syntax to call this method. Also it doesnt seem like my Test2.vb class is correctly included in the project because If I make a type the project still builds successfully when it shouldnt

View 2 Replies

Use The HtmlEncode (or HtmlDecode) Function In Visual Studio?

Dec 21, 2011

I'm making an application that involves logging into a server, however, the post data needs some encoding.

Dim strEncUsername As String = Server.HtmlEncode(Me.txtUsername.Text)

However, since this isn't an asp.net application, this doesn't work. How the hay am I supposed to do this? I tried looking for an Imports thing, but no real luck.

View 3 Replies

Visual Studio 2010 - Does The Print() Method In .NET Work With Files Opened With Binary Access

Mar 6, 2011

I am trying to write data to a binary file using the Print() method, but when I run it I get the System.IO exception Bad File Mode.

Here's the code for the FileOpen declaration, that might have something to do with it?

FileOpen(filenumber, "path to file", OpenMode.Binary, OpenAccess.Write, OpenShare.LockReadWrite)
Print(filenumber, expression(variable))

View 1 Replies

.net - Visual Studio Vs. #Develop - Default Event Handlers?

Feb 19, 2009

Visual Studio and SharpDevelop do not both set up delegates to handle events in the same way. The way they are set up is a little bit different. This makes it difficult to use VS in one place and #Develop in another (on the same project).For Example, in VB, Visual Studio does the following:

Private Sub OK_Button_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles OK_Button.Click
Me.DialogResult = System.Windows.Forms.DialogResult.OK
Me.Close()
End Sub

Friend WithEvents OK_Button As System.Windows.Forms.Button So that the control is declared, not only with a different scope (this can be a problem also, but not the topic of this post) but with a withevents. The event handler is then assigned to it by a handles clause.

[Code]...

The most annoying thing about this, is even if it is done one way, the other ide will redo it, having duplicate declarations, and of course, compile time errors.Does anyone know of a way around this, some way to customize the default handlers? even if it is just some way that they can be turned off, so it can just be typed manually?

View 4 Replies

Onclick Event For A Button In Visual Studio 2010

Dec 5, 2009

I am a new vb user and I have the beta of Visual studio 2010.I have to make a button redirect to another form IN THE SAME FOLDER [code]Now, I assume that if I dont want to mess with the code, I need to click the buttn, go into the properties, events,click.What identifier should go into the click box so that it will automattically open up a file in the same folder?

View 3 Replies

Autocomplete - Visual Studio Intellisence Auto Create Function ()

Jun 1, 2011

In visual studio programming in Vb.Net you get a special autocomplete around functions. If you add a name in front of a statement the rest of the line is treated like function parameters.

strInEditBy dsInfo.Tables(0).Rows(0).Item("plandesc").ToString()

strInEditBy ( dsInfo.Tables(0).Rows(0).Item("plandesc").ToString() )

I wanted to add a = operator in the place of the ( but unless I type really fast it auto-adds the ( ). How can I turn that off.

View 1 Replies

Visual Studio 2008 - Invoke Onclick Function In Html From .net Or C#?

Mar 15, 2010

I am trying to invoke the onclick function in an html page that displays content. I am using the httpwebreqest control and not a browser control. I have traced the function and tried to find the link it calls but looking at the code below I tried inserting the link into the browser with the main url but it does not work.

[Code]...

View 1 Replies

Configuring A Customized Timer Event In Visual Studio 2010?

Jan 17, 2012

I'm having issues on where to begin on the next step in my Visual Studio 2010 project.

Here's my original code:

Private Sub Form1_KeyDown(ByVal sender As Object, ByVal e As System.Windows.Forms.KeyEventArgs) Handles Me.KeyDown
If e.KeyCode = Windows.Forms.Keys.VolumeUp Then Shell("C:USBRelayUSBRelay.exe -c:3 -r:1#1")

[Code]....

View 13 Replies

Set The Default Event To Be Edited For Custom Control In Visual Studio?

Aug 23, 2010

I made a custom button by inheriting the Button class. When I double click the custom button in Designer, it makes the event handling function for MyButton.Click:

Private Sub MyButton1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyButton1.Click
End Sub

[code]....

View 2 Replies

Visual Studio 2010 Addnew Event And Save To A New Database?

Feb 26, 2012

Can someone help me i am trying to add and save customers to my database and it doesnt seem to be letting me unless i directly go into the grid and add them there. You can see that the addnew button adds them but it wont save them. when i go back and preiview the data on the table its not there. I am just tring to develope a regular simple customers database

View 3 Replies

Visual Studio Shortcut To Auto-Add Event Delegate Methods

Sep 2, 2009

In C# adding event handler methods is very easy. You just type "object.event +=" and then press tab twice. Is there anything like this for VB projects? Note: This is for dynamically created controls or controls that are not declared WithEvents.

View 1 Replies

Function Call For Multiple Textboxes Using Visual Basic Studio 2008

Feb 17, 2010

I am working to make a function that will update the back color of a text box based on multiple variables values. I can write the code to do the calculation, but I am not sure how to make the function realize which text box to update (as I will have about 30 different boxes). Below is the code that I have for each box so far, but I will have quite a few more, and would rather use a function to reduce the amount of code, and also make it cleaner as well.

If sngPreviousPrimaryPropertyTotal >= sngPrimaryPropertyTotalCost Then
txtPreviousPrimaryPropertyTotal.BackColor = ColorProgramLightGreen
Else
txtPreviousPrimaryPropertyTotal.BackColor = ColorProgramLightRed
End If
[Code] .....

Or is there a way that I can tell the function that it's updating the text box that call the function in the first place? Say if txtBox1 has updated text and calls the function, then the function 'knows' to update txtBox1, but will update txtBox2 when it's called by txtBox2.

View 3 Replies

Visual Studio 2010 - .NET Function As String, Will Return False Be A Boolean?

Sep 21, 2011

I have a HTTP class that gets content from URL's, POST's content to URL's etc and then returns the raw HTML content.In the function inside of the class it detects if there is a HTTP error and if so I would like to return false but will this work if I have declared the function to return a String?

Code Sample of what I am trying to do (Note the Return Content & Return False if a HTTP error code is detected)Public Function Get_URL(ByVal URL As String) As String

[Code]...

View 1 Replies

How To Perform Onkey Event In An Excel Add-In Created With Visual Studio 2010

Apr 17, 2012

I am creating an Excel Add-In using Visual Studio 2010. I would like to run some code when users clicks a combination of keys.Here is the code I have got

Public Class CC
Private Sub ThisAddIn_Startup() Handles Me.Startup
EnableShortCut()
End Sub
Sub A1()

[Code]...

The Add-In when installed shows an error on clicking the short cuts. It says the specific macro cannot be found.The code under the Sub EnableShortCut() works well when it is in an excel vba module. The same won't work when it is added to an Excel Add-In created with Visual Studio.

View 4 Replies

C# - Web Matrix Differ From Visual Studio - Is It More Efficient Than Visual Studio To Develop ASP.NET Web Project

Oct 12, 2011

WebMatrix is a web development and deployment tool by Microsoft so how is this compared to Visual Studio? which Use C# Razor Syntax is that more better coding.

[Code]...

View 2 Replies

Compile A Solution In Visual Studio 2005 Which Was Compiled In Visual Studio 6?

Sep 15, 2009

I have to compile projects which was compiled in Visual Studio 6 in Visual Studio 2005. When i compiled i got a set of same error. I opened the project for VS6 by selecting File->open->project/solution and tried to build a solution by Build option but i am getting the following error.

[Code]...

View 7 Replies

Open Visual Studio Express Files With Normal Visual Studio?

Apr 11, 2011

Is it possible to open visual studio express files with normal visual studio?

View 2 Replies







Copyrights 2005-15 www.BigResource.com, All rights reserved