Documentation - Introduction

Coding standards for Rational Robot

(Continued from previous question...)

Documentation - Introduction

Documentation is done to provide others with information and ease maintenance. The best documentation is done in the headers (function and scripts) and directly in the code. Any useful thoughts ie a chosen algorithm or a solution to a specific problem should be documented in order to help others understand the script(s) and/or function(s).

(Continued on next question...)

Other Interview Questions

• Rational Robot's Coding Standards
• Naming Convention - Local scope variables
• Naming Convention - Module-level variables ("member-vars")
• Naming Convention - Arrays
• Naming Convention - Globals
• Naming Convention - Constants
• Naming Convention - Functions
• Naming Convention - Scripts
• Naming Convention - Libraries
• Naming Convention - Verification points
• Functions - Introduction
• Functions - Parameters
• Functions - Indention
• Functions - Return value
• Functions - Error handling
• Functions - Size
• Scripts and libraries - Introduction
• Scripts and libraries - How to deal both scripts and libs
• Scripts and libraries - Size
• Documentation - Introduction
• Documentation - Functions
• Documentation - Scripts
• Documentation - Module level variables
• Documentation - Libraries