Advertisement
Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- ################# CONVENTIONS ##############################
- # always use a correct structured parent order, first define names/elements and finally actions or values, example: city_car_wheel_pressure
- ## Variables:
- # CAPITALIZED_VARS environment/global variables
- # is_* for booleans
- # flag_* for mark dynamic states
- # ignore_* ignore methods of work
- # force_* force things
- # mode_* generic modes of work (verbose, debug, update)
- # edit_* interactive modes
- # clean_* to clean things while working
- # *_ suffix for all the local variables
- # *_array for array variables
- # *_list for a list of data
- # *_CONST for constant (fixed) variables
- # *_found for "found" marks variables
- # *_snap for snapshoted/freezed states or values
- # *_reg for registering variables (logs)
- # *_n for vars representing numbers
- # *_No same, for the full number
- # *_cursor for "looping" type variables (uni-dimensional)
- # i,j,k.._* for iterator variables (multi-dimensional)
- # plural names for a collection of objects
- # large variables for long-scope (usage), small names ones for low scope
- # avoid negative values for a easier read: if ! [[ ! -z is_Not_ignored ]]...
- # smallest name possible but important to use a unique meaning
- # short time of use as possible for every variable
- ## Functions:
- # _* everything which purpose is to compute or evaluate, that return a result
- # __* very-temporal functions for help useful the development of the application, like __step_checkme
- # is_* run a unique test/evaluation in boolean return (FIXME: change verify_ one's to this one)
- # do_* for actions, should return result of the action
- # check_* which purpose is to process one or more evaluations of data
- # reg_* the ones that does register things (logs, debug, statistics, etc)
- # finish_* terminate processes, executions, forks or tasks
- # compute_* compute something, find, search, etc...
- # show_* functions that are meant to show something
- # build_* build or generate big things
- # run_* launch something, if requires check of variables or computations of data first
- # initalize_* initialize things, variables, flags, constants, etc
- # *_update update actions
- # *_manage working / tools
- # *_new creating new elements
- # *_get get values
- # *_set set values
- # *_put actions of sending
- # *_find look up things
- # *_begin first events
- # *_end last events
- # *_clean make clean
- # *_ui user-interfaces (interactive)
- # complement names reduce complexity by symmetry: get/set, add/remove, create/destroy, start/stop, insert/delete, increment/decrement, old/new, begin/end, first/last, up/down, min/max, next/previous, open/close, show/hide, suspend/resume, etc.
- #############################################################
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement