diff options
author | Alexander Köplinger <alex.koeplinger@outlook.com> | 2017-05-23 15:27:42 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-05-23 15:27:42 +0300 |
commit | beb36c6a3174bd05bebac966ce0a62c0fad9f51d (patch) | |
tree | 0bc371d4674445c82c20e0c7fb06f83e0224345a /mcs/class/README | |
parent | a0fc3f4dcf571edc997f53066c09671650e96670 (diff) |
Remove outdated info and unused files from mcs/ (#4916)
Most of the removed files weren't touched in the last decade
and are unused so it's better to remove them to avoid confusion
about what they do.
I also went over and removed the most outdated info from readme
files, we probably want to do a more thorough overhaul in the future.
Diffstat (limited to 'mcs/class/README')
-rw-r--r-- | mcs/class/README | 258 |
1 files changed, 1 insertions, 257 deletions
diff --git a/mcs/class/README b/mcs/class/README index 421c04da2bf..b2692bf6927 100644 --- a/mcs/class/README +++ b/mcs/class/README @@ -35,15 +35,6 @@ testing. 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_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, - ONLY_1_1 - * Tagging buggy code If there is a bug in your implementation tag the problem by using @@ -69,255 +60,8 @@ testing. not only stupid, but leading to unreliable code). In those cases, use the keyword "LAMESPEC". - * Coding considerations and style. In order to keep the code consistent, please use the following - conventions. From here on `good' and `bad' are used to attribute - things that would make the coding style match, or not match. It is not - a judgement call on your coding abilities, but more of a style and - look call. Please try to follow these guidelines to ensure prettiness. - - Use 8 space tabs for writing your code (hopefully we can keep - this consistent). If you are modifying someone else's code, try - to keep the coding style similar. - - Since we are using 8-space tabs, you might want to consider the Linus - Torvals trick to reduce code nesting. Many times in a loop, you will - find yourself doing a test, and if the test is true, you will nest. - Many times this can be changed. Example: - - - for (i = 0; i < 10; i++) { - if (something (i)) { - do_more (); - } - } - - This take precious space, instead write it like this: - - for (i = 0; i < 10; i++) { - if (!something (i)) - continue; - do_more (); - } - - A few guidelines: - - * Use a space before an opening parenthesis when calling - functions, or indexing, like this: - - method (a); - b [10]; - - * Do not put a space after the opening parenthesis and the - closing one, ie: - - good: method (a); array [10]; - - bad: method ( a ); array[ 10 ]; - - * Inside a code block, put the opening brace on the same line - as the statement: - - good: - if (a) { - code (); - code (); - } - - bad: - if (a) - { - code (); - code (); - } - - * Avoid using unnecessary open/close braces, vertical space - is usually limited: - - good: - if (a) - code (); - - bad: - if (a) { - code (); - } - - * When defining a method, use the C style for brace placement, - that means, use a new line for the brace, like this: - - good: - void Method () - { - } - - bad: - void Method () { - } - - * Properties and indexers are an exception, keep the - brace on the same line as the property declaration. - Rationale: this makes it visually - simple to distinguish them. - - good: - int Property { - get { - return value; - } - } - - bad: - int Property - { - get { - return value; - } - } - - Notice how the accessor "get" also keeps its brace on the same - line. - - For very small properties, you can compress things: - - ok: - int Property { - get { return value; } - set { x = value; } - } - - * Use white space in expressions liberally, except in the presence - of parenthesis: - - good: - - if (a + 5 > method (blah () + 4)) - - bad: - if (a+5>method(blah()+4)) - - * For any new files, please use a descriptive introduction, like - this: - - // - // System.Comment.cs: Handles comments in System files. - // - // Author: - // Juan Perez (juan@address.com) - // - // (C) 2002 Address, Inc (http://www.address.com) - // - - * If you are modyfing someone else's code, and your contribution - is significant, please add yourself to the Authors list. - - * Switch statements have the case at the same indentation as the - switch: - - switch (x) { - case 'a': - ... - case 'b': - ... - } - - * Argument names should use the camel casing for - identifiers, like this: - - good: - void Method (string myArgument) - - bad: - 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 { - - bool Method (int argument_1, int argument_2) - { - if (argument_1 == argument_2) - throw new Exception (Locale.GetText ("They are equal!"); - - if (argument_1 < argument_2) { - if (argument_1 * 3 > 4) - return true; - else - return false; - } - - // - // This sample helps keep your sanity while using 8-spaces for tabs - // - VeryLongIdentifierWhichTakesManyArguments ( - Argument1, Argument2, Argument3, - NestedCallHere ( - MoreNested)); - } - - bool MyProperty { - get { - return x; - } - - set { - x = value; - } - } - - void AnotherMethod () - { - if ((a + 5) != 4) { - } - - while (blah) { - if (a) - continue; - b++; - } - } -} - + conventions: http://www.mono-project.com/community/contributing/coding-guidelines/ |