Finance | Project Operations, Human Resources, ...

What is the best practice for naming variables in standard class and newly created class?

(0) Share

Report

Posted on by junior AX

1,552

If i create a new table and name it with ModelNameTableName ex: XXTable and put fields field1,field1

if i use this table in a new class that i created ex: XXclassName, if i want to use the table in this class do i need to name the variable with XX

i mean XXTable xxTable; or can i do it XXTable table;

what is the best practice for this?

Also if use this new table in a standard class should i name the variable

XXTable xxTable; or XXTable table; ???

I have the same question (0)

All responses (5)

Answers (0)

Suggested answer

nmaenpaa 101,162 Moderator on at

Like (1)

Report

The most important thing is to use your prefix / suffix. You can check Microsoft's recommendations here: docs.microsoft.com/.../naming-guidelines-extensions

The reason why you should use prefix/suffix is to avoid conflicts with future MS updates, and other customizations / ISV solutions.

You should also use prefix/suffix it when adding new variables to standard classes. Otherwise there could be a conflict if Microsoft adds a variable with the same name.

So, whenever you are adding something that could have a naming confict with future MS updates, you need to use your prefix/suffix:

- All new objects

- All elements in table/form/entity extension

- All methods and class variables in class augmentation, as well as child classes of standard classes

Was this reply helpful? Yes No
junior AX 1,552 on at

Like (0)

Report

So if i created the class(not standard)

There is no need to name the variable of XXTable with xxtable as this should not conflict with MS but it won't hurt to do it?

Was this reply helpful? Yes No
Suggested answer

nmaenpaa 101,162 Moderator on at

Like (0)

Report

Inside your class you don't need to use any prefix/suffix for variable or method names. It doesn't hurt but I would not do it.

Was this reply helpful? Yes No
Blue Wang on at

Like (0)

Report

Hi Junior,

Variables of specialized types (extended data types) should have the same name as the type (which should have a logical name) but starting with a lower case character.

If you have more than one variable of the same specialized type, use logical names that contain the name of the type as a prefix.

Please read this: docs.microsoft.com/.../naming-conventions-variables

Was this reply helpful? Yes No
Suggested answer

Martin Dráb 237,965 Most Valuable Professional on at

Like (0)

Report

I would avoid including prefixes in variable names, unless there is a reason to do that (e.g. if you have XxxCustTable and remove the prefix, it would look like the variable is of type CustTable instead of XxxCustTable).

Your goal should be writing code that is easy to read, and these prefixes makes names longer (typically) without adding any value, therefore they decrease quality of code.

Was this reply helpful? Yes No

Join the conversation

Community site session details

What is the best practice for naming variables in standard class and newly created class?

Helpful resources

Quick Links

Responsible AI policies

Neeraj Kumar – Community Spotlight

Congratulations to the November Top 10 Community Leaders!

Leaderboard > Finance | Project Operations, Human Resources, AX, GP, SL

Featured topics

Product updates

Community site session details

What is the best practice for naming variables in standard class and newly created class?

Helpful resources

Quick Links

Responsible AI policies

Neeraj Kumar – Community Spotlight

Congratulations to the November Top 10 Community Leaders!

Subscribe to this forum!

Select categories

Leaderboard > Finance | Project Operations, Human Resources, AX, GP, SL

Featured topics

Product updates