Naming standards can help identify objects that are obsolete or temporary and reduce object redundancy. Without good naming standards, encyclopedia users create redundant objects or use obsolete ones. When this happens, the users often must re-subset to delete the object usage and include the correct object.
Standard naming conventions can also be used to communicate the purpose or status of a shared object. By having a naming convention, an object list search is quicker and more likely to succeed. A common reason for object searches is to locate an action diagram or exit states to include in new code. In addition to a naming convention for shared objects, a good description further indicates whether the object is suitable for the developer. Good in-line comments communicate how the action block should be implemented.
Another use for naming conventions is to tag obsolete objects. If an obsolete object cannot be deleted (because it is referenced in some way), the object can be renamed so that it's obsolete status is communicated. One possibility is to rename it so that it begins with "ZZ_OBS_" and follow that with as much of its original name as possible.
This naming scheme groups all obsolete objects at the end of an object list. You can easily find them and the name clearly indicates to the users to remove them from their code and subsets. This in turn makes it easier to eventually delete the objects and reduce the size of the model.
A naming convention for temporary objects is also helpful in locating and removing unnecessary objects. One possibility is to start the name with "ZZ_TEMP_" followed by the developer's initials and then whatever descriptive information the developer chooses. This naming scheme also groups temporary objects at the bottom of the list. It makes them easy to find and identifies the developer. The objects can be deleted if the developer forgets.
The last example of naming conventions is to have the developers name their subsets starting with their initials. It reminds the developers of all subsets they have so that they can reuse any that are obsolete. It also identifies to all other developers the owner of the subset.
|
Copyright © 2013 CA.
All rights reserved.
|
|