Computer Science 121 - Lab 4b: Code Policy

You may have already started developing code but if not you soon will. Your team has to come to an agreement on the coding practices you'll use. In this lab you'll begin to develop a policy by addressing two major issues.

  1. Naming policy: You should establish a policy for creating names for variables, methods, classes, etc. Here are some questions you should consider:
    1. Does your naming convention distinguish between private and public data and methods?
    2. Will names be formatted for readability?
      Does your policy emphasize descriptive names, particularly ones that refer to real-world concepts instead of programming language concepts?
    3. Does your policy prevent practices that cause common bugs such as names mispelled to make them shorter, hard to read characters (e.g. l and 1)
    4. Does your policy ensure booleans are named so that their true meaning is clear.
  2. Documentation: You should establish a documentation policy (a la CS70).


Upload your work to your trac.