Wish [B4X] Sub comment to show along side the sub in the modules pane

Cableguy

Expert
Licensed User
Longtime User
I guess a picture can replace 1000 words...

1698524673158.png


My simple wish, the comments we add to a sub, that allows a brief description of the sub function, should also show on the Modules pane.
This would help ease the search of particular subs in large projects
 

Sagenut

Expert
Licensed User
Longtime User
I really like this idea.
The only problem is that it's possible to write long multiline comment.
So this function should report only the first one, my idea.
And we should learn to use the first line always a Title Only.
'Edit GPS Card
'This button will let you edit the GPS Card Settings.
'Why this?
'Because we are
'Strong
'Beautiful
'We Love Options
'WE USE B4X
 

Sagenut

Expert
Licensed User
Longtime User
Anyway is a good practice to give a meaningful name to the views.
 

Cableguy

Expert
Licensed User
Longtime User
Anyway is a good practice to give a meaningful name to the views.
Yes, but sometimes, you can't find that "good meaningful name" to name your view...
In my case, this project is a collaboration, and the name I give to a view or a sub may not be as "meaningful" to the other coder as it is to me, so a short description should help greatly.
Like in my example, I could have given the Button a name like Edit_Gps_Card_Btn but then I call some sub named, let's say, Edit_Gps_OK_btn, this, with underscores, makes it readable, EditGpsCardBtn & EditGpsOKbtn could be somewhat easy to mix.
Also, really meaningful names tend to be too long!
 

Cableguy

Expert
Licensed User
Longtime User
This is another example, where the sub HAS a meaningful name, complemented by the subs description:
B4X:
'Populates the TreeTableView with the Files List from the Chosen Directory
Sub AddFolder(Parent As TreeTableItem, Folder As String)

If this wish is granted, the length of the first line should also be limited in size, 50 or 60 characters long.
This could end up like
B4X:
'Populate TreeTableView1 with Files List from Chosen Directory 
Sub AddFolder(Parent As TreeTableItem, Folder As String)
 
Top