Naming Conventions

CromeDome on 2004-11-04T20:59:10

At what point does naming become cumbersome? For example:

DEVNET::PropertyTax::Parcel::TaxDistricts

where:

DEVNET = my company ;) PropertyTax = product (as opposed to Recorder, Imaging, etc.) Parcel = Piece of property TaxDistricts = Taxing districts a parcel is in

I had started doing DEVNET::PropertyTax::Assessment (for a property's tax assessments) and so forth originally. Then I ran into a problem: I had previously defined DEVNET::PropertyTax::TaxDistricts, which is the listing of all possible tax districts. But now the above seems too lengthy. Is it? What do others do? Am I being too organized?


Length

phillup on 2004-11-04T21:43:25

But now the above seems too lengthy.

I've often seen people remark about long names (tho usually with function/method calls).

Personally, I don't worry about it when it comes to modules. I try to organize them in a manner that makes it easy for me to find the code I need to work on.

That is my sole naming criteria. It has to make sense so I can find my code.

As for length... well, I only have to type the module name twice. Once for the use clause, and once for the new statement.

After that, I use the object name.

Abbrv.

schwern on 2004-12-01T10:05:21

Abbreviate the company name and project.

DEVNET::PropertyTax::Parcel::TaxDistricts

becomes

DN::PT::Parcel::TaxDistricts.