.NET Tutorials, Forums, Interview Questions And Answers
Welcome :Guest
Sign In
Win Surprise Gifts!!!

Top 5 Contributors of the Month
Gaurav Pal
Post New Web Links

C#: XML Comments Let You Build Documentation Directly From Your Visual Studio .NET Source Files

Posted By:      Posted Date: August 21, 2010    Points: 0   Category :ASP.Net

C# allows developers to embed XML comments into their source files-a useful facility, especially when more than one programmer is working on the same code. The C# parser can expand these XML tags to provide additional information and export them to an external document for further processing. This article shows how to use XML comments and explains the relevant tags. The author demonstrates how to set up your project to export your XML comments into convenient documentation for the benefit of other developers. He also shows how to use comments to generate help files.

J. Andrew Schafer

MSDN Magazine June 2002

View Complete Post

More Related Resource Links

Toolbox: Easy File Backup, Exploring Files And Folders Inside Visual Studio, Multiple Monitor Softwa


If the responsibility for creating, managing, and executing routine backups is yours, these tools will make it easier. Also see how you can browse folders and files from inside Visual Studio.

Scott Mitchell

MSDN Magazine May 2009

Use The Source, Luke: Source Server Helps You Kill Bugs Dead In Visual Studio 2005


The latest releases of WinDBG and Visual Studio know exactly how to use source server, so its benefits are available to both .NET and native C++ developers. See why this is so important in tracking down bugs.

John Robbins

MSDN Magazine August 2006

XML Comments: Document Your Code in No Time At All with Macros in Visual Studio


Starting in Visual Studio 2005, XML documentation support will become available in Visual Basic and C++ as it has been for C#. However, making full use of the many comment tags will take a little extra work In this article, the author shows how Visual Studio macros can be used to automate the creation of XML documentation and creates macros that write large sections of comments with just a keystroke.

Tony Chow

MSDN Magazine July 2005

Test: Build Quick and Easy UI Test Automation Suites with Visual Studio .NET


The .NET Framework provides a surprising new way to quickly and easily create user interface test automation. By using objects in the System.Reflection and System.Threading namespaces, you can write automated tests in minutes instead of hours. This article walks you through the building of a typical Windows-based application that will be used as the test subject. The author then runs through the creation of a C#-based test tool that simulates clicking the test app's UI controls and checks the application's state. After the tool is built, the author explains in detail how it works so you can modify and extend it for your own use.

James McCaffrey

MSDN Magazine January 2003

Visual Studio .NET: Build Web Applications Faster and Easier Using Web Services and XML


Visual Studio .NET includes exciting features, some of which are enhancements to previous versions and some of which are brand new. A few of the most significant additions are the new Microsoft programming language called C#; a new, smarter integrated development environment; new object-oriented features in Visual Basic .NET; and development lifecycle tools. This article provides an overview of these features, as well as a look at Web Services, Web Forms, and new versions of ADO and ASP. It takes a first look at dozens of important new Visual Studio features that aid in the design, development, testing, and deployment of solutions built with Visual Basic, C++, Visual FoxPro, and C#.

Dave Mendlen

MSDN Magazine September 2000

The Weekly Source Code 56 - Visual Studio 2010 and .NET Framework 4 Training Kit - Code Contracts, P

Do you like a big pile of source code? Well, there is an imperial buttload of source in the Visual Studio 2010 and .NET Framework 4 Training Kit . It's actually a 178 meg download, which is insane. Perhaps start your download now and get it in the morning when you get up. It's extremely well put together and I say Kudos to the folks that did it. They are better people than I. I like to explore it while watching TV myself and found myself looking through tonight. I checked my blog and while I thought I'd shared this with you before, Dear Reader, I hadn't. My bad, because it's pure gold . With C# and VB, natch. Here's an outline of what's inside. I've heard of folks setting up lunch-time study groups and going through...(read more)

Visual Studio 2010 Creates Two Solution Files


When I create a new file system based web application in Visual Studio 2010, for example, named as "MyWebSite", two folders were created by the studio: MyWebSite and MyWebSite(2). The second folder only contains a solution file while the first folder has the solution file as well. Is this a new feature? Where is the setting that can avoid the second folder? Thanks,

Free or open source UML add-ons to Visual Studio 2008

Hi there, Like to know any open source UML tool, which can be added to Visual Studio 2008 as add on   Thanks,

Visual Studio 2005 loses shared data source credentials upon restart...Has it...or Will it ever be f

This issue was submitted via feedback on connect.microsoft for SQL Server on 5/14/09 and I can't seem to find anywhere that says it has been fixed!!!  I just got a new PC and they imaged my PC after another co-workers and he was having this issue and now so am I!!  I'm desperate for a resolution as I have to restart almost daily and I have several shared data source connnections...  Here are the details that were submitted to Microsoft....  Please any help is appreciated!!   Type: Bug ID: 450753 Opened: 5/14/2009 4:31:05 PM Access Restriction: Public       0 Workaround(s) view 18 User(s) can reproduce this bug         I recently installed Service Pack 3 for SQL Server 2005 on my local machine, and now my saved credentials for my shared data sources in my Reporting Services project in Visual Studio 2005 SP1 are gone every time I restart my computer. I have to enter the specific User Name and Password into the Credentials tab every day for each shared data source. This problem never occurred before I installed SQL Server 2005 SP3, and now my co-workers are afraid to install SP3 on their machines. The server already has SP3 installed. Details (expand) Product Language English Version SQL Server 2005 SP3 Category Rep

Parsing flat files or tab delimited files.csv with Visual Studio and or Biz Talk Server.

Hello msdn community, I need help with finding the proper Microsoft application that will allow me to parse a .csv  flat file / tab delimited file for its text, The data will be queried client side dynamically populated to my web page form with Visual Studio 2008.  I have read that a MS Biztalk Server will perform a similar function, I am still checking on this. Has anyone in the community had experience with flat file parsing with Microsoft software and or hardware? Any and all help will be appreciated in helping me resolve this issue because I am not well versed with the Microsoft products. Spidaweb Web Designer /Webmaster Virtual Web Dev, LLC.

Out Of Memory during build in Visual Studio

Hi All,I have Visual Studio 2005 SP1, Win XP SP 2 on a machine with 2GB physical memory and over 200 GB free hard disk.I am getting out of memory exceptions from visual studio while building. It used to happen once a week or so, but now the frequency is up to 3-8 per day. It is getting insanely painful. The only way that I can seem to fix it is by restarting visual studio - which ends up being 5-15minutes of waiting. So as you can imagine - being forced to restart visual studio every couple of hours really sucks. The other people in my team get the same thing so it is not something specific to this machine.I am working on a fairly big solution - it has 102 projects including libraries, wcf services, some asp.net web services and a few client executables. Every time I get out of memory, there is always heaps of free memory reported by the task manager. Visual studio itself is using between 400-700 mb of memory and there is always 700-1.2 GB free physical memory.So, it manifests as a build error most frequently (occasionally it happens in the designer and other places - but I'll forget that for now since it is only once or twice a week) - randomly with no warning I get the build error:The "ResolveManifestFiles" task failed unexpectedly.System.OutOfMemoryException: Insufficient memory to continue the execution of the program.   at Microsoft.Build.Tasks.Deployment.Manife

Visual Studio doesn't build with InternalsVisibleTo if using a CodeActivity within the same assembl


I have unit test projects to test some workflows. So I have some InternalVisiblesTo in my main project so my test project can call them. But when I do workflows (.xaml) in the test project using some codeactivity also defined into the test projects, the build doesn't see the InternalVisiblesTo attribute and I get errors like this one :

Error 1 'BugVSInternalVisiblesTo.Class1' ne contient pas de définition pour 'Method1' c:\Projects\BugVSInternalVisiblesTo\ActivityLibrary1\CodeActivity1.cs 9 41 ActivityLibrary1

Here are the steps to reproduce easily my case :

1- Create a C# Class Library project with this code :

using System.Runtime.CompilerServices;
[assembly: InternalsVisibleTo ("ActivityLibrary1")]

namespace BugVSInternalVisiblesTo
  public static class Class1
   internal static void Method1 ()

2 : Create a new C# Workflow ActivityLibrary project named "ActivityLibra

Visual Studio 2005 can't find my files in subfolders, why?!


I am having a heck of a time with this.  Visual Studio 2005 SP1 can not find my files and javascript files whenever I put it in the subfolders.  In the solution explorer, I've created subolfders such as /js and /css.  This is inside my main folder:  AJAXEnabledWebApplication1\css  and AJAXEnabledWebApplication1\js

In HTML code, when I put this: <script type="text/javascript" src="js/jquery-1.4.2.js"></script>
    <script type="text/javascript" src="ui/jquery.ui.core.js"></script>
    <script type="text/javascript" src="ui/jquery.ui.widget.js"></script>
    <script type="text/javascript" src="ui/jquery.ui.mouse.js"></script>
    <script type="text/javascript" src="ui/jquery.ui.selectable.js"></script>

every single one of them is highlighted that it can not find the specified file.  But wait, if I add those files manually to the root folder and to the solution explorer, it is no problem!!?? why?!?

why is this happening?

inside the reference paths for the program, I've also pointed to the root folder location:

c:\document adn settings\myname\my Docum

Error 1706 - No valid source could be found for product Visual Studio.NET Enterprise Architect 2003


Error 1706 -  No valid source could be found for product Visual Studio.NET Enterprise Architect 2003 - English.

The Windows installer connot continue.

-----This error occured while Build Solution of my Window Service project created to export data from xml file to sql server database.

Please help me regarding this.Thanks for everyone of you.


How to add notes in source code(Visual studio 2010)?


Hi can anyone pls tell me how to add notes in source code in Visual Studio 2010? I only want the notes to be viewed in source code view, not design view! 

I tried

//notes here

'notes here

but they all ended up showing in the design view, HELP PLS!

Show codeanalysis messages in the build summary or log view(build detail screen in visual studio)

Is there a way to show  codeanalysis messages in the build summary or log view(build detail screen in visual studio).  Right now it run and output the details to an xml file. I would also like it to show in the detail view screen.  Thanks.

Can I use visual studio 2010 to build and deploy 2007 solutions?

Actually I have some 2007 code someone gave me.  I haven't used those external wsp builders for a long time.  I don't know if I can just use vs 2010.
ASP.NetWindows Application  .NET Framework  C#  VB.Net  ADO.Net  
Sql Server  SharePoint  Silverlight  Others  All   

Hall of Fame    Twitter   Terms of Service    Privacy Policy    Contact Us    Archives   Tell A Friend