Uitleg bij classes

[bn2vs]

Is er een manier om uitleg te laten verschijnen in de tooltip die je krijcht als je een procedure, property, functie, of iets anders van een class gebruikt, maar dan bij een zelfgemaakte class?

Ik kwam overlaatst langs deze code, dus veronderstel dat het wel kan op een of andere manier (vind enkel niet hoe)

    <Browsable(True), Category("Layout"), DefaultValue(FlowDirection.RightToLeft), Description("Gets or sets the the direction which the tabs are drawn.")> _
    Public Property TabsDirection() As FlowDirection
... code ...
    End Property

Kan iemand me hier ff mee verder helpen?
Alvast bedankt

 

[kabourterplop]

Ja dat is mogelijk.

Dat doe je door de volgende code

    ''' <summary>
    ''' Met deze sub kan je een error laten zien standaard laat hij niks zien.
    ''' </summary>
    ''' <param name="showError">Als je deze waarde op True zet krijg je een error venster</param>
    ''' <remarks></remarks>
    Private Sub showError(Optional ByVal showError As Boolean = False)
        If showError = True Then
            MsgBox("Error", MsgBoxStyle.Critical)
        End If
    End Sub

Dit is het resultaat

Ik hoop dat je dit bedoelde

 

[bn2vs]

Ok, thnx, hij doet het
Vind de code wel redelijk vaag ziet er niet echt .net-achtig uit

Vraag opgelost

 

[bn2vs]

Als ik ctrl+spatie druk na het onderstaande te typen krijg ik nog een zooi dingen. Waar kan ik info vinden over wat ze precies doen?
''' <

 

[kabourterplop]

Laat eens zien wat je krijgt

 

[bn2vs]

Dit is alles wat er in die lijst staat, maar ik weet niet precies wat het doet

''' <summary></summary>
''' <param name="sender"></param>
''' <param name="e"></param>
''' <remarks></remarks>
''' <exception></exception>
''' <include></include>
''' <permission></permission>

 

[kabourterplop]

<param> is de omschrijving van een variable die je mee zendt naar een sub en voor de rest weet ik het ook niet.

Ff googlen?

 

[bn2vs]

summary, param, en remarks lijken me redelijk duidelijk, maar de rest niet. als ik erop google krijg ik een hele zooi andere crap

 

[Jabber]

Waar kun je voor gebruiken:

Als je een code document gaat schrijven. In .NET VS kun je een xml file genereren welke alle functie's bevat die je in je programma hebt.

De xml style achtige dingen zijn dan beschrijvingen die bij deze functie horen. Er is een opensource programma die deze file kan lezen en een .doc file genereert.

Zo kun je dan in de .doc lezen welke functie wat doet:
''' <summary></summary>
Korte beschrijving van de functie

''' <param name="...."></param>
Welke params geef je mee en wat doen ze.

''' <remarks></remarks>
Extra info: korte snippet is makkelijk hoe je het moet implementeren

''' <exception></exception>
Welke exceptie wordt opgegooid als er een exceptie optreedt

''' <include></include>
Welke imports, includes moet je gebruiken voor deze code.

''' <permission></permission>
Wie heeft permissie

Deze items moet je zelf invullen, maar als je het gewend bent en stug blijft vasthouden hieraan, kun je de code erg goed beheersen en is het makkelijk overdraagbaar.

Ik gebruik echter een subset:
''' <summary></summary>
''' <param name="sender"></param>
''' <param name="e"></param>
''' <remarks></remarks>

Dit vind ik genoeg. Remarks gebruik ik alleen als het een complexe manier van gebruiken is.

 

[bn2vs]

Heel erg bedankt voor die uitleg

Als ik het goed begrijp bevat <include></include> dus uitleg over welke andere functies/procedures/classes/components er toegankelijk moeten zijn vanuit het ding waar je het bijzet?

 

[Jabber]

Ja, maar die zul je toch echt zelf in moeten vullen.

Kan namelijk gebeuren dat je een stukje code wilt hergebruiken.
Dan weet je meteen welke classes je ook mee moet nemen.

 

[bn2vs]

Ok, das handig

Bedankt voor de uitleg - vraag opgelost