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
ADVERTISEMENT
Feb 16, 2012
Note: This question is similar to How to prevent the copy of XML documentation files in a release mode build?, but it's not the same and the answers there don't apply. Read on to find out why. (Please ask in the comments or in chat if you disagree, I'll be glad to elabroate).
I have a library project (myLibrary) and an ASP.NET web application project referencing this library (both are in the same solution). "Generate XML documentation file" is checked for the library project, because I want to have those nice IntelliSense features while developing.
When I publish the web application (Context Menu on the project/Publish...), it copies only the files required for running the application (no source code, etc.) to some publish directory. That's good. Unfortunately, it also copies the XML documentation file of the library. Since I consider our library's documentation to be a trade secret, I wouldn't want it to end up on a customer's server. Thus, we have to remember to manually remove this file from the publish directory before deploying it.
Is there a way to prevent Visual Studio from copying this file when publishing the ASP.NET project, but still retain the benefit of XML documentation IntelliSense when developing?
View 4 Replies
Feb 10, 2012
I am developing a next gen App for my Email Client for future Windows 8 users. Now when i used to use Visual Studio (Visual Basic) 2008 to develop for Windows 7, I used the command "FORMNAME.show()" And that command would open the form.The Problem i am having now is that "SHOW" is not included and im guessing that there has to be another way to do this. For the Beta version of my app, i created a test Button that i want to open a "SplitPage1" the button is called " btnOpen"?Now to give you an idea what i wanna do, i made buttons on the top right hand corner that are called "File , Edit , View" and so on, and when the user clicks file, i want a spiltpage to open with all the options the user would regularly have when clicking file on a menu tab in a program. the options would be lined up on the left hand side when you hover over lets say "New Email" on the right hand side there will be a short description that will appear saying "create a new email to send" and when clicked on it will take the user back to the mainPage and it redirect the browser to "SendnewEmail url".
View 2 Replies
Apr 6, 2010
[url]...
Documentation error, now corrected in Visual Studio 2010. Re: Convert.ToUInt64?
View 1 Replies
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
Mar 28, 2009
Visual web developer 2008's .sln file is not working in Visual Studio 2008
View 2 Replies
Nov 4, 2008
The issue at hand is that when I try to run my projects from within Visual Studio (2008 with freshly installed SP 1 ), one fifth of the times it hangs, showing me this lovely dialog telling me that visual studio is currently busy, and that I can either switch to the busy part, or continue waiting - and nothing happens when clicking either buttons.Thing is, it never continues from that point, and the only solution I found so far was to close down the process called blabla.vshost.exe. At this point my Visual Studio will either give me message saying 'Error: Unable to run project' and I can run the project again, and hope it'll work this time, or Visual Studio will say that an error occurred and then it restarts VS leaving me to reload the project.
I think it has something to do with building the .exe. I believe VS studio hangs when the .exe is already in use by vbhost.exe, and it therefor cannot overwrite the old exe-file.
View 2 Replies
Apr 7, 2011
I have two projects made in vc++ & vb.net of visual studio 2005.now i a third project in vb that integrates above two.I HAVE SEARCHED GOOGLE and result is negative
View 4 Replies
Apr 14, 2012
we are new to Visual Basic Programing, We are working on a project, which has modules. My team worked on these modules and prepared 3 separate Visual Studio Projects. Now, I want to combine then into one Visual Studio Project for Integration purposes
View 2 Replies
May 4, 2012
I'm creating a new website in Visual Studio 2010 Ultimate / vb and I want to add things to it, to jazz it up. So I'm adding new projects from the VS online templates. It seems there are many more projects in c# than vb. I'm trying to figure out if it's okay to add a c# and razor project to a vb website, because if not, I'll start the website in c#.
Will mixing languages between projects within your website present issues in the future when it comes time to build and publish? Or is it recommended I begin the website in c# (since there are more projects within VS) and keep the languages the same throughout the website?
View 3 Replies
Apr 30, 2012
Single file for all interfaces or one file per interface definition? Balena & Dimauro's of book of 'Pratical Guidelines' advocates a single file called Interfaces.vb/cs to hold all interface definitions. Their aim is to minimise the proliferation of small files, where each holds a single interface definition.I can see benefits to both approaches. Does anyone have any strong views or experience that strongly supports one approach?
View 2 Replies
Jan 3, 2008
When I try to add a new project to our existing Visual Studio solution, it now adds a ProjectSection(WebsiteProperties) for ALL projects in the solution, although only three of 24 projects are web sites.
Only an Undo Checkout can undo this.
What is causing this new behavior (Visual Studio 2005 SP1 v8.0.50727.762 (SP.050727.7600)) ?
How can I disable it?
View 6 Replies
Oct 26, 2010
In Visual Studio 2005, I can't seem to get the Intellisense menu to pop up at all when I click CTRL+Space. This seems to be limited to VB.NET files. I have tried creating new Visual C# and C# web projects, and it works fine there. There also doesn't seem to be a problem in things like CSS files in VB.NET projects. But when I create a new VB.NET web site, CTRL+Space does nothing. I have tried resetting all the Import and Export setting. That didn't work either.
View 1 Replies
Jun 2, 2011
I need to migrate projects that was made in visual studio 2003 but this projects includes several applications that acts as the base for different clients and every client has its own personalization of the product.visual studio 2008 use an architecture in order to turn everything into a single system with differents configurations?
View 1 Replies
Apr 29, 2010
I couldn't find a quick answer on the official pages,is it possible to write VB projects in the express edition of Visual Studio that connect to a SQL Server that is not the included 'Express' server ?
View 1 Replies
Jun 12, 2009
In the "old days" I was working with Linux to create C/C++ programs (really really BASIC...HA!...programs, just learning to program in the courses as an intro) by creating a text file with the source code that was then fed to the compiler/linker that then spit out the executable binary.
[Code]....
View 2 Replies
May 31, 2011
I'm running Visual Studio 2010 on a terminal server, and have been, with relatively few problems, for some time. This morning I fired up my PC and over the UK's long weekend, the following issue seems to have developed.I've got a bunch of projects (but not all of my projects, and not all of the projects in a given solution) complaining that a particular file (which does not exist on the computer) cannot be opened, and so those projects will not compile anymore. Here's the error:
Error 31 Unable to open module file'C:Users[username]AppDataLocalTemp2.NETFramework,Version=v4.0.AssemblyAttributes.vb':
System Error &H80070003&
I could simply copy the file into that directory and be done with it, I'm pretty sure that will work,EDIT: Okay, now things have gotten to a whole new level of weird. I've rebooted the server, I get the same error message, only now the file it is asking for exists and can be opened in Visual Studio with no problems. another part of the IDE still insists that it's unable to open the module file.
EDIT 2: Can't delete the file because it claims to be open in another program, but I've logged off and logged on again, and there shouldn't be anything accessing it.
EDIT 3: Because there's a wall of comments below his answer, I'll mention here that Jared's suggestion to delete the SUO file for the solutions having the problem (not files specifically to do with any of the problem projects, strangely) was what solved this, eventually.
View 2 Replies
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
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
Apr 11, 2011
Is it possible to open visual studio express files with normal visual studio?
View 2 Replies
Jan 10, 2010
I get an error that says Setup Stopped working when installing Microsoft Visual Web Developer 2008 Express Edition with SP1 . Everything else installed fine. I am using the Offline ISO.
EDIT: This happens with the new 2010 Beta 2 also.. same exact error message.
Here are the details:
Description:Microsoft Visual Web Developer 2008 Express Edition with SP1 - ENU has encountered a problem during setup. Setup did not complete correctly.
[Code]...
Google search does not help. What is really funny about this is that from my search I see there are multiple solutions for this problem that have worked for different people, none of which apply to my situation.Why do I get the feeling that God does not want me to learn VB programming? (Grin)
View 1 Replies
Aug 20, 2009
I want to put a button on my Visual Web developer 2005 Express edition page (one single web page) that will close the internet web browser (IE 7 being used), when my users click on the closed button. I need to write visual basic code to closer the browser but haven't found an example that explains how to do this in code. Can someone give me an exmaple of how to accomplish this in Visual Basic Code.Paul Mayer
View 1 Replies
Oct 6, 2010
Me.Close() doesn't work.
View 3 Replies
Jul 21, 2009
im try to do a profile page in my website. has anyone done one before and if so have they any sample code i can look at im using sql 2005 and visual web developer 2008
View 8 Replies
May 23, 2009
I am C# developer and now I am involved in some large, already in production, project that is written in Visual Basic.NET.I am trying hard not to write in C# and use some automatic conversion tool to Visual Basic.NET. I want to be able to read and write fluently in Visual Basic.NET QUICKLY. I can write and read VB.NET but it is not so easy like writing and reading C#.
View 3 Replies
Jan 19, 2009
I am developing a Windows-application - database mssql - visual basic.I add Datasets to forms, bind them to daatagridview/textboxes - fill with dataadapter - everything's fine so far.
Here's my question:how do I programmaticaly move from a record/datarow i a dataset to another.I know the value of the key-field and want that record to be shown. If I use the dataset.datatable.findbykey-method, the program finds the record, but it doesn't move there.
View 5 Replies
Jun 13, 2009
i need to know how to posing things in visual web developer without the line thing
View 1 Replies
Sep 10, 2008
I am trying for the first time, to create a web application which uses xml files to store data and I cannot get it to function right.On a web page I have a Label (label1) which I need to reflect the cityname of a zipcode typed in a textbox (textbox1).From another webpage I have tried this example (But I cant get it to work how to read and write data from an xml file in Visual Web Developer 2008 ???:xml File
<?xml version="1.0" encoding="utf-8" ?>
<ProgramSample>
<name Language="French">
<MenuTitle>asdasd</MenuTitle>
[code].....
View 7 Replies
Jun 30, 2010
As far as I can work out I should be able to copy a web project/application to my IIS Web server and be able to see it as I do when designing it on my development computer.
The problem is once I copy the folder over to my web server and then try to view it the browser it says Error 404 not found. There must be a real simple fix for this. I would like to be able to develop ASP.NET sites using the Visual Web Developer instead of Dreamweaver but this little issue is stopping me.
View 1 Replies
Apr 7, 2012
I have a web page that has a few text fields, and a reset and submit button. I'm having trouble getting the reset button to work to clear the text fields because the required field validators and regular expression validators are blocking any code in the reset button's click event from occurring. how to get the validators to not activate when the reset button is clicked? One method I tried was to set the enabled property of all the validators to false in the reset button's code block but no luck.
View 3 Replies