I 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].....
I have a Class Library that is exposed to COM like this:
<ComClass(SomeClass.ClassId, SomeClass.InterfaceId, SomeClass.EventsId)>
Public Class SomeClass
Public Const ClassId As String = "GUID1"
Public Const InterfaceId As String = "GUID2"
[Code]....
Compile error:
Function or interface marked as restricted, or the function uses an Automation type not suppport in Visual Basic.
What do I need to do to properly expose this Method so I can use it like this?:
SomeClass.SomeMethod 1, 2, 3
I've got one function with a paramarray, and I want to pass the same paramarray to a second function. I do not control the second function, and so cannot modify it.
Public Sub Main()
Foo(1,2,3,4,5)
End Sub
Public Sub Foo(ParamArray Byval arg as Integer)
[code]....
How to use the ExecuteReader calling a stored procedure with a parameter array?
View 1 RepliesIs it possible to do something like this (don't know how to form correct syntax):
Public Property MyProperty as ParamArray Date
Get
...
[code]....
A former co-worker wrote a class in C# that was to be used as an attribute. I'm having to convert his work to VB (yeah, it's pointless and way more work than necessary, but management thinks it's a good idea). Unfortunately I'm having an issue because one of the main properties of the class is an ArrayList which is set with a ParamArray in the constructor. The class looks like this (note I've tried to abstract out the problem, so this is a simplified version of the class only)
<AttributeUsage(AttributeTargets.Field Or AttributeTargets.[Property])> _
Public Class LabelAttribute
Inherits Attribute
Public Sub New()
[CODE]........
In the first one, there is just the single label being added. No Problem. In the second one there are 2 different labels being added. Again, no problem. The third one, however, is a problem because it's assuming that the "Description", which is supposed to be the description is instead being interpreted as another label.
This wasn't a problem in C# because it could be set as follows:
[CODE].................
Of course this doesn't work in VB because optional parameters aren't referred to by name as they are in C#. As a stopgap I've changed the constructor to allow only a single label like this
CODE]..................
But that undermines some of what this class is meant to do. Does anyone know how, or even if I can get the same basic functionality to work in VB?
Think there must be a way to make the existing design work. Imagine this class was built into a library that I could not modify. Would I be forever forbidden from setting Description because of this design?
I have an application that reads data values (numeric) from a data file. Due to a change in data requirements, I need to put these into a paramArray so I can calculate the MEDIAN of the series of numbers. I have seen some of the MSDN examples and they are all good except they load the paramArray with ArrayName(#, #, #, #, #). That's OK for a simple example, but how do I load a paramArray while reading numeric data from an ASCII input file? The number (Ubound) of samples is usually 153 but can vary considerably.
I think I can work out the rest of the MEDIAN calculation from the MSDN example code.
I'm building a class, and i let the user select several options to show or hide some features in another form.In my class i declared an enum with 5 values, and in one of my class constructors i declare an paramarray of the type of the enum.Now i want that when i declare a new object of this type, when the user put the "(" char, a popup/tooltip/intelisense (don't know what to call it), show all the options available. Like in the classes that allready exist in the framework...
View 7 RepliesSounds simple enough, but its not working. In this example, I want to set the values of 3 fields to equal a 4th. I could do something like this..[code]...
Values in the param array did not get updated in the return! I was expecting to have all of the final values now be "1", like they are in the Function.
Is there any way to get an update-able ParamArray collection like this? ParamArray must be declared ByVal, but with a reference type like String, shouldn't that only make a copy of the pointer and allow me to change the underlying value?
I have a method which I need to call which accepts a ParamArray
Method(ByVal ParamArray elements() As Object)
I need to pass it two known strings, and an unknown number of strings, based on a variable number of XmlNodes in an XmlDocument[code]...
where can i find some good documentation or training on how to use WMI?
View 3 RepliesI 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?
The 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 RepliesI 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 RepliesHere'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..
I 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]...
I 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)
I 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]...
When 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 RepliesOne 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.
how 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].....
I 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 RepliesI 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 but do not know how to access it. [URL] [URL]
View 1 RepliesI 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?
View 4 RepliesIf 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]...
I'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 RepliesIs 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.
there 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.