next up previous index
Next: Source Files and Packages Up: Coding Guidelines Previous: Methods and Side-effects   Index

Documentation and Comments

Have a doc string for every public class and method. Doc strings for internal methods are optional - use your good judgment.

Include informative comments, of course. Comments should be at the right level -- comment entire methods and potentially obscure bits of code; don't comment obvious things.


next up previous index
Next: Source Files and Packages Up: Coding Guidelines Previous: Methods and Side-effects   Index
info (at) urbansim.org