mcs/class/README

   1 The class libraries are grouped together in the assemblies they belong.
   2
   3 Each directory here represents an assembly, and inside each directory we
   4 divide the code based on the namespace they implement.
   5
   6 * Missing implementation bits
   7
   8         If you implement a class and you are missing implementation bits,
   9         please put in the code the word "TODO" and a description of what
  10         is missing to be implemented.
  11
  12 * Tagging buggy code
  13
  14         If there is a bug in your implementation tag the problem by using
  15         the word "FIXME" in the code, together with a description of the
  16         problem.
  17
  18         Do not use XXX or obscure descriptions, because otherwise people
  19         will not be able to understand what you mean.
  20
  21 * Tagging Lame specs
  22
  23         Sometimes the specification will be lame (consider Version.ToString (fieldCount)
  24         where there is no way of knowing how many fields are available, making the API
  25         not only stupid, but leading to unreliable code).
  26
  27         In those cases, use the keyword "LAMESPEC".
  28
  29 * Coding consideration
  30
  31         Use 8 space tabs for writing your code (hopefully we can keep
  32         this consistent).  If you are modifying someone else's code, try
  33         to keep the coding style similar.
  34