Explain a function and the values of its parameters

Post

Posted
Rating:
#1 (In Topic #1135)
gambafeliz
Enthusiast
gambafeliz is in the usergroup ‘Enthusiast’
 I would like to explain a function and its parameter values in autocomplete. That is, when the programmer calls the function and wants to understand the values of its parameters, he normally displays contextual help.

How can I do it, can someone explain it to me?

Thank you
For your misfortunes I am Spanish and I only know Spanish, please, be patient with me, Thank you. :)
Online now: No Back to the top

Post

Posted
Rating:
#2
BruceSteers
Guru
BruceSteers is in the usergroup ‘Guru’

gambafeliz said

I would like to explain a function and its parameter values in autocomplete. That is, when the programmer calls the function and wants to understand the values of its parameters, he normally displays contextual help.

How can I do it, can someone explain it to me?

Thank you

You put the help before the function by starting each line with 2 single comment quotes (not a double-quote) ' then use markdown / html code
Like this…

Code (gambas)

  1.  
  2. '' ## This is help that shows
  3. ''
  4. '' It has <font color=red>markdwon syntax</font> like **bold** etc
  5. '' * lists
  6. '' * 'code quotes' etc
  7.  
  8. Public Sub MyFunction()
  9.  
  11.  
  12.  
Online now: No Back to the top

Post

Posted
Rating:
#3
BruceSteers
Guru
BruceSteers is in the usergroup ‘Guru’
for properties you put the help at the "Property" line not the Property_Read bit

Code (gambas)

  1. ' Gambas class file
  2.  
  3.  
  4. '' Help for a public variable goes here
  5. Public MyPublicBool As Boolean
  6.  
  7. '' Help for a property goes here
  9.  
  11.  
  12. '' Help for a function goes here
  13. Public Sub MyFunction()
  14.  
  16.  
  17. Private Sub Prop_Read() As String
  18.  
  19.   Return$sProp
  20.  
  22.  
  23.  

You can also access the wiki in links (or other urls)

Code (gambas)

  1.  
  2. '' See help on TreeView.Current  [/comp/gb.qt4/_treeview/current]
  3. Property Current As _TreeView_Item
  4.  
  5. '' Get a variable from it's settings string, See [/comp/gb.settings/settings/fromstring]
  6. Public Sub GetSetting(SValue As String) As Variant
  7.  
  8.   Return Settings.FormString(SValue)
  9.  
  11. /gb[
Online now: No Back to the top

Post

Posted
Rating:
#4
gambafeliz
Enthusiast
gambafeliz is in the usergroup ‘Enthusiast’
Just what you need, thank you.
For your misfortunes I am Spanish and I only know Spanish, please, be patient with me, Thank you. :)
Online now: No Back to the top
1 guest and 0 members have just viewed this.