Conventions
0. Everything should be documented 1. Function prototyping is necessary 2. Good documentation of functions: 1. Description 2. Input parameters 3. Required globals 4. Return value 5. Error codes (if any) 3. Variable naming use of _ with short names 4. Variable should be declared like: declare var as string/hash/array/int/... 5. No hints (Usually programming language specific statements) 6. 4 spaces indentation 7. Use of namespace::function(); 8. All literals to be named in uppercases 9. Log priorities: 0. EXPLOSIVE - Catastrophic errors, Security intrusion attempts, internal inonsistencies in code or data, OS level, error like disk IO errors etc. 1. AUDIT - All audit messages 2. FAIL - BU errors or failures in biz logic, including DB errors 3. SUCCESS - All successful BU events 4. INFO - All info messages 5. DEBUG1 - Debug logs useful for TSEs 6. DEBUG2 - Only for programmers. 10. All important data structures must be documened, preferable with sample data. 11. Naming conventions for literals: 1. E_ERR__ for errors 2. E_MSG_ _ for info messages 3. L_ for literals 12. All special characters should be escaped before passing it to any service e.g., syslog, database etc.
»
- Login to post comments
- Printer-friendly version
- Send to friend
Why do we need forums?
Why not newsgroups?
We have starcom.proj.merce. I feel we should create a proj.merce.v3 and use it for the stuff you seem to need to discuss. The "project" you are working on is not the MUI of Merce. It's Merce v3.
Shuvam