correct spelling mistakes (#4405)

[mono.git] / mcs / class / README

diff --git a/mcs/class/README b/mcs/class/README
index bf82cecee7f19c2eb42c45b0016864902e5bbfdb..421c04da2bfd3b360a1fd5f2c9b17adfde0b221e 100644 (file)
--- a/mcs/class/README
+++ b/mcs/class/README
@@ -25,10 +25,20 @@ testing.
                throw new NotImplementedException ();
        }
 
+       Ideally, write a human description of the reason why there is
+       a MonoTODO, this will be useful in the future for our
+       automated tools that can assist in developers porting their
+       code.
+
+       Do not use MonoTODO attributes for reminding yourself of
+       internal changes that must be done. Use FIXMEs or other kinds
+       of comments in the source code for that purpose, and if the
+       problem requires to be followed up on, file a bug.
+
 * Supporting .NET 1.2, .NET 1.1 and .NET 1.0 builds
 
-       The defines NET_1_1 and NET_1_2 are used to include
-       features.   When NET_1_2 is defined, it also implies that the
+       The defines NET_1_1 and NET_2_0 are used to include
+       features.   When NET_2_0 is defined, it also implies that the
        NET_1_1 is defined.
 
        To have code which is only available in an old version, use ONLY_1_0,
@@ -124,7 +134,7 @@ testing.
                                        code ();
                                }
 
-               * Avoid using unecessary open/close braces, vertical space
+               * Avoid using unnecessary open/close braces, vertical space
                  is usually limited:
 
                        good:
@@ -224,6 +234,45 @@ testing.
                                void Method (string lpstrArgument)
                                void Method (string my_string)
 
+               * Empty methods: They should have the body of code using two    
+                 lines, in consistency with the rest:
+
+                       good:
+                               void EmptyMethod ()
+                               {
+                               }
+
+                       bad:
+                               void EmptyMethod () {}
+
+                               void EmptyMethod () 
+                               {}
+               
+               * Line length: The line length for C# source code is 134 columns.
+
+
+                 If your function declaration arguments go beyond
+                 this point, please align your arguments to match the
+                 opening brace, like this:
+
+                       void Function (int arg, string argb,
+                                      int argc)
+                       {
+                       }
+        
+                 When invoking functions, the rule is different, the
+                 arguments are not aligned with the previous
+                 argument, instead they begin at the tabbed position,
+                 like this:
+         
+                       void M ()
+                       {
+                               MethodCall ("Very long string that will force",
+                                       "Next argument on the 8-tab pos",
+                                       "Just like this one")
+               
+                       }
+               
        Here are a couple of examples:
 
 class X : Y {