Define code and text style for the documentation

[cleberjamaral]

• style for jason code (standard is snake_style)
• style for artifact properties and actions (under discussion, see meeting minutes 230301)

[cleberjamaral]

Regarding the code style:
Snake_style is agreed to be the standard for jason code (prolog)
For the artifacts, it seems it is very subjective, so it can change according to the application [suggested by Tim]
Most important is to be consistent on the documentation [Andrei]
Jomi will send an email to everybody with a deadline for checking the documentation and make comments

[oboissier]

Looking at the proposal for identifiers, not convinced by this non uniform style for identifiers that let clearly appear in the syntax the source of the identifier.
Question: one agent bob has a belief anObsProp created by an artifact. bob sends it to alice. alice has a new belief anObsProp that doesn't come from an artifact she is focused on. Maybe bob didn't want to share to alice that this belief issued from an artifact.

I would prefer a homogeneous writing style for identifiers, being from agentspeak program, organization program or from the observable properties or actions used in the AgentSpeak program issued of the Artifact world. One solution could be to go to a knowledge level style (snake?).

Olivier

[oboissier]

Regarding Comments, what about giving a label to each plan, with a comment à la Java?

[jomifred]

link for source of the document: https://github.com/jacamo-lang/documentation/blob/main/programming-style/index.adoc

visualisation: https://jacamo-lang.github.io/documentation/programming-style/index.html

[rbordini]

Hi, thanks all. I agree with Olivier that at last the identifiers in the Environment code that will go up to the level of the agent and organisation should have the same formation rule as the other names for goals, beliefs, roles, etc. We could use snake there, only for the observable properties and follow Java convention for the rest of the Java code or alternatively we move everything to Camel, after all not many people use logic programming languages where the snake style was the fashion 50 years ago. But I'm happy either way.

[jomifred]

I added AR in the issue, given his expertise on env side.