B4J Question Is there a standard way to document and code B4J libraries?

[B4JExplorer]

Hi,

Do we have any kind of recommended way, to develop class libraries, in B4J?

In other words, when we want a developer to be able to see the description of a method, in a picklist from the xml description, where do we place the description comments?

Also, is it possible to generate javadoc for the B4J libraries?

Finally, does B4J have a recommended naming convention? I use a modified hungarian notation, but am open to changing that style.

 

[Erel]

You are asking about libraries created with B4J, right?

The comments above the subs will be added to the xml file automatically.

Also, is it possible to generate javadoc for the B4J libraries?

No. However there is a tool in the forum that allows you to convert the xml file to the forum bbcode: https://www.b4x.com/android/forum/threads/18564/#content

Finally, does B4J have a recommended naming convention?

See the (simple) naming convention that is used in all the core libraries.

 

[dilettante]

It lookes like CamelCaps for class members mixed with camelBack for arguments.

Sometimes a "usage" suffix (e.g. srcOffset) is added but generally nothing like a type prefix (i.e. no strSearch, it would be just search or Search).

 

[Erel]

I usually use CamelCaps.

 

[B4JExplorer]

Sounds good, thanks Erel/dilettante.