Reignite An Auto-documentation?
Sep 17, 2011I 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 Replies
ADVERTISEMENT
Documentation Or Training On How To Use WMI
May 16, 2011where can i find some good documentation or training on how to use WMI?
View 3 RepliesIDE :: XML Documentation With ParamArray?
Mar 7, 2012I 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].....
Providing Help Documentation In .NET?
Apr 26, 2010I 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?
Use The MSDN Documentation?
Feb 28, 2010The 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 Replies.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 RepliesC# - Find Detailed Documentation For .Net?
Nov 20, 2009Here'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..
C# - Force Documentation In VS(2010)
Mar 13, 2012I 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]...
Create An Application Documentation?
Sep 29, 2011I 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)
Documentation - XML Comments Not Showing On .Net?
Aug 25, 2009I 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]...
Get A Documentation For Unit Tests In VS TS?
Aug 27, 2009When 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 RepliesIDE :: XML Documentation Comments Not Working?
Sep 1, 2006One 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.
Reference Xml File Documentation?
Sep 22, 2009how 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].....
Structured Text In VB XML Documentation?
Apr 7, 2008I 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 - How To Access
Aug 23, 2010Website, Documentation but do not know how to access it. [URL] [URL]
View 1 RepliesWhere Can Found Begininvoke Documentation
Mar 1, 2011I 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
Mar 26, 2009Where is the regular expressions documentation?
View 4 RepliesWindows InitiateSystemShutdown And MS Documentation
Nov 7, 2011If 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]...
Office Auto-mation :: Auto-mating Excel Spreadsheet Creation?
Jun 5, 2009I am trying to just write something to a cell in a sheet and I am getting the error message:
Exception Exception from HRESULT: 0x800A03EC Stack Trace: at System.RuntimeType.ForwardCallToInvokeMember(String memberName, BindingFlags flags, Object target, Int32[] aWrapperTypes, MessageData& msgData)
[code].....
C# - Documentation For Bouncy Castle AES 256 Encryption In .Net?
Aug 5, 2010I'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 RepliesC# - Multiple Language Examples In XML Documentation?
May 24, 2010Is 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.
Generating Documentation Like MSDN But Manually?
Jun 7, 2010there are tools (SandCastle?) that can generate an MSDN-like documentation (HTML files) from your source code by using the XML comments above members. I am looking to generate a similar documentation (bunch of HTML files that one can link through), except not from XML comments but completely manually.It is for a custom scripting language, I have to document the available functions, and it would be great if I could do that in this common documentation style. Since there are no XML comments to generate the documentation from (the documentation is for the scripting language itself, not for my source code of the scripting language?
What I'm looking for in detail is a way to generate these documentation files by simply supplying this information for each function:
- Namespace (just the name and maybe a description)
- Function name + description + return type
- List of arguments and their types
from this I would to generate a document where one can first view all the Namespaces, click one (they are supposed to be links) and view all the functions in that namespace. Then you can click on a function name and view its description and list of arguments for that function.In other words: just like these automatic tools do, except now I want to supply this information manually.
While writing this I thought of one way that I might be able to do it: just create namespaces and functions in actual VB code (corresponding to the scripting language functions) and generate the documentation from that, but
1) That seems a little contrived especially if a better tool is available,
2) I would be in trouble with the types of functions and arguments, since they would have to be .NET types and not the types that my scripting language supports.
IDE :: Class Description Structured Documentation?
Sep 25, 2011I 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.
View 3 RepliesIDE :: Function Description(documentation) Not Working In .NET?
Sep 28, 2009How 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)
View 14 RepliesIDE :: Syntax - Documentation On The MS Chart Control
Dec 12, 2010I amincluding the code I am using below. My problem is syntax. I can't any documentation on the MS Chart control. Th code below I found in various code examples, but I can't seem to find the remaining necessary examples fro labeling the X and Y axis. I have 12 monthly values, Jan-Dec that I am trying to plot. I can the graph to print, but don't know how to lable it. Why does this have to be so hard to discover?
[Code]...
IDE :: XML Documentation And Intellisense File Locking?
May 20, 2009I'm currently having issues with the following scenario:
1. I will build several DLLs with "Generate XML Documentation" set.
2. The DLL and XML files are copied onto another server (the build drop).
3. The copy will fail as the XML files are being locked by other users referencing these DLLs from their open Visual Studio projects.
Note that this also occurs on a local computer; open up two Visual Studios and use reference paths to reference the Binary folders. You'll find that the refrencing instance of Visual Studio will lock up the XML files causing the first Visual Studio to have problems compiling.
1. Is this a bug in Visual Studio 2008? Why is it holding exclusive locks on these files from the other computers? Is there a fix for this?
2. Is there a way to "package" the XML file into the DLL? I've noticed a lot of other .NET DLLs in the world that include all of their comments INSIDE of the DLL. No XML files necessary. (unless they're not .NET dll's).We're doing a lot of framework development here and it's imperative to include the XML documentation... unfortunately we've had to disable it to allow new builds to trickle through.
Inline Documentation For A Interface Implementation?
Jul 14, 2010Is there any way to include some kind of auto-generated comments as part of implementing an interface? Studio automatically fills the headers for the methods, can I auto-fill some sort of code comments at that same time? (to help remember what each interface method is supposed to do without looking at external documentation.) For example, if I could get the interface's XML Intellisense markup headers to copy from the interface down to the implementation's level.
View 3 RepliesIs There Any Documentation Somewhere That Describes How This My Namespace Works
Jan 8, 2009The following line of code failed to compile in a project targeting .Net 3.5 ( I am using VSTS 2008 and this is the only copy of VS installed in my system):The project type is class library.key = My.Computer.Registry.CurrentUser.OpenSubKey(keyString, False)the error message is:"Name 'My' is not declared."I have couple questions regarding the issue- Where the My namespace is defined? I am wondering if i missed to add a reference in the project.Is there any documentation somewhere that describes how this My namespace works?
View 4 RepliesOperators - <> And Not - Write Standards Documentation ?
Mar 16, 2009I'm having the exciting task of finding out about VB.NET's <> and Not operators. Not - I'm assuming by my small use of it - is the functional equivalent of ! in languages such as C# and <> being equivalent of !=.
In VB.NET a common problem is doing Boolean expressions against objects that don't have a reference, it appears. So if we do If Request.QueryString("MyQueryString") <> Nothing Then This will actually fail if the query string doesn't exist. Why, I don't know. The way that it's done by older coders is as follows: If Not Request.QueryString("MyQueryString") Is Nothing Then
And this tends to work. To me they're functionally equivalent though operators tend to do different comparisons dependent on certain factors such as operator precedence, why it doesn't work in this case however, I do not know, and neither have I found any relevant material. I ask this as I'm having to write standards documentation and we're determining the use of either the Not or <>.
QsRules Documentation Store Operations?
Sep 6, 2010I am programming hooks for store operations using the qsrules.dll but I do not find information about his variables you can help her obtain?
View 2 Replies