Application Architect best practices: Naming rules

4 Posts
2 Users
0 Likes
34 Views
(@admin_doc72)
Posts: 493
Member Admin
Topic starter
 

Hi.

Today, I would like to speak about best practices. I came across one thing that recently has become some kind of naming rule when working with the Architect:
Usually, we recommend to start parameter names with the character "p".

In fact, I think that this is inconvenient. The reason is that upon applying input parameters to a template instance the parameters are sorted alphabetically.

201=35 ArchitectInstanceInputParameters

But usually, you would like to apply input parameters on the highest possible level. You would expect to find these parameters on top of the list.

Therefore, I would recommend the usage of the underscore as first character of a parameter:

201=36 ArchitectInstanceInputParameters2
 
Posted : 19/10/2012 10:23 pm
LM
 LM
(@l-micaudarcinfo-com)
Posts: 383
Member Admin
 

Thank you Armin for this post.
That is exactly what we advise during training. _pParameterName.

We should also write other posts related to best pratices.
Scada basic program extention .scb
Scada basic varaible naming rules, function naming rules...

I exist on the training course but maybe we can write others and publish a KB article!
So not only ARC employee (who must know it of course) will use these best practices one day.

 
Posted : 20/10/2012 5:18 pm
(@admin_doc72)
Posts: 493
Member Admin
Topic starter
 

Yes, sure. I fully agree.
Adding an extension to a file on a Windows platform for sure is good style. As PcVue by default does not suggest any particular file extensions I usually use the following extensions in projects:

  • Mimic file: .mmc
  • Mimic template file: .mmt
  • Symbol file: .sym or .obj
  • Scada Basic script: .scb
 
Posted : 22/10/2012 1:33 pm
LM
 LM
(@l-micaudarcinfo-com)
Posts: 383
Member Admin
 

Good idea for mimic and mimic template.
For symbols I vote for .sym

 
Posted : 23/10/2012 1:06 pm