I am trying to use the <code> tag inside the <example> tag to show a sample code in xml documentation. However, when I build the Sandcastle project, I see that it is shown as C#. There is no language attribute in <code> tag. And I could not find a setting in Sandcastle's project properties.
View 1 RepliesI'd like to be able to exclude members that, although Public, are decorated with EditorBrowable.Never.I can't see any where to do it in the options. Is there a plug-in out there where you can specify attributes to exclude?
ETA: Looks like I may have found it - the <exclude /> Tag. I'm just testing it now....
ETA2: Yes it works.
Is there any other good free/open-source tool for documentating besides Microsoft's Sandcastle and NDoc, that is easy to use, has a GUI and generates HTML documentation?
View 4 RepliesSource code documentation tool for VB.NET 10 ?
View 4 RepliesI have xml summary comments for each and every function and class of my windows project. Now I want to generating the XML Documentation File. I gone through the following link, but the Option was not there in my Solution explorer.
[URL]
what tools do you use to create programming flowchart/documentation from VB.NET source code? There are absolutely no comments/documentation at present. I am a beginner, i.e. I tried Sandcastle but it is way over my head and could not get it going, not even with GUI.Fatesoft's CodeVisual To Flowchart is OK but it is almost the same as the code and I still don't understand the code.
View 3 RepliesI've been using sandcastle builder to make my help file documentation for our code base. It works real good just out of the box, but I need to customize it a little.How do you you format remarks? In the xml comments in code, you can have tabs and carriage returns and such to make things look readable, but all that get's taken out by Sandcastle and it gets converted to one long paragraph.For instance:
''' <remarks>An example of how to use this function would be:
'''
''' Using Selector As ObjectSelectors.FacilitySelector = [code]......
Would end up looking like:An example of how to use this function would be: Using Selector As ObjectSelectors.FacilitySelector = ObjectSelectors.FacilitySelectorUtils.GetStandardFacilitySelector(Me.m_Project, Me.m_Map) Selector.Text = MessageCaption If Selector.ShowDialog = Windows.Forms.DialogResult.OK Then 'add these facilities to the list For Each FacilityRow As Data.DataRow In Selector.SelectedItems If Not Me.BarricadingFacilityTable.Rows.Contains(FacilityRow(0)) Then Me.BarricadingFacilityTable.ImportRow(FacilityRow) End If Next End If End Using
I know there must be some kind of tag I can use - or would it be a bunch of tags? Or is there a setting in Sandcastle Builder?
I was working on a project in vs 2005 and decided to see my project's form in microsoft blend, the form did not show and i closed blend and saved no changes. The next time i open my project in visual studio, my form1 design mode shows me some code for the windows form designer. How can i get my form back as i need to add more controls and change the orientation of some others?
View 10 RepliesWhen I try to open up a form designer, all I see is code and no form! How can I open up the designer, since the code says to modify using the designer and not the code editor?[code]....
View 4 RepliesSomething happened to my project and it got all messed up. I am not sure what happened, but the form I was working on only shows the code and not the project itself(where you design it). I am working in VB2008 Express Edition and do not wish to start over. What happened to my form?
View 6 RepliesI'm having some problem with VB project in visual studio 2008, when I open or create a new project in VB only code is displayed in the design tab but no GUI and toolbox is greyed out.
View 3 RepliesI am using a background worker, it runs fine but it does not shows the result. i am using jmcilhinney source to work it out.. have a look.
VB Imports System.ComponentModelImports System.Text.RegularExpressionsImports System.NetImports System.IO Public Class WorkDialogue Private _result As Long = 0L Public ReadOnly Property Result() As Long Get Return Me._result End Get End Property Private Sub
[CODE]...
And the button codding in other form:
VB Using dialogue As New WorkDialogue dialogue.ShowDialog()TextBox2.Text = dialogue.Result.ToString() End Using
There are so many controls, properties, etc in VB 2008 .NET it's mind boggling. I'm amazed at how much this product can do.Does anyone know of a VB 2008 .NET book that describes in simple language and shows sample code for all of those controls, properties, etc?
View 5 RepliesThis is a UPD server code to receive from any ip address but when i run it its shows "Cross-thread operation not valid".
Imports System.Net.Sockets
Imports System.Text
Imports System.Net
Imports System.Threading
[CODE]..................................
I'm having trouble finishing up this salary program which is designed to calculate salary based on gross sales while using arrays. Essentially, when the Calculate Salary click event is initiated after salary is entered, either $200 should show up in the list box or, if the persons sales were over $5,000, a calculation of their sales * 9% + 200 should show up in the list box. Right now, anytime I enter any number, "Double Array()" shows up in that list box. Additionally, a bar graph is supposed to supposed to be displayed in the lower list box showing how many people are in certain categories starting from "$200-$299" through "over $999". These results should be shown when the Show Totals click event is initiated.
[code]...
where can i find some good documentation or training on how to use WMI?
View 3 RepliesI 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 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 Replies