Skip to content
This repository was archived by the owner on Aug 8, 2023. It is now read-only.

Commit b0a4085

Browse files
author
Mike Klemarewski
committed
Update README.md
1 parent 381b9b7 commit b0a4085

1 file changed

Lines changed: 2 additions & 6 deletions

File tree

java/README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,11 @@ You can import the provided AndroidStyle.xml file into Android Studio by:
99
5. Choose the AndroidStyle option under the scheme drop down at the top.
1010
6. Click apply, and OK
1111

12-
1312
# Rules
1413

1514
## Comments
1615

17-
Use Javadoc comments for **classes**, and **nontrivial public** methods.
16+
Use Javadoc comments for **classes**, and every **public** method. For protected and private methods, use your own discression. Eg. if a protected method is going to be overridden a lot, write a JavaDoc comment!
1817

1918
**Remove** comments generated by Android Studio when class files are created. Typically it will append something like:
2019

@@ -23,13 +22,10 @@ Use Javadoc comments for **classes**, and **nontrivial public** methods.
2322
* Created by MikeKlemarewski 2014-12-22
2423
*/
2524
```
26-
Which are noisy and useless. If you need to know who created the file, look at the Git history.
25+
These are just noise. If you need to know who created the file, look at the Git history.
2726

2827
## Member Variables
2928
Do **not** prefix member variables with 'm'. Member variables should be declared at the top of the class if they are used often, otherwise they should be declared right before they are used.
3029

3130
## Methods
3231
Methods should be kept as shorts as possible. There is no hard limit. Methods should do one thing, and do it well. If a function starts to creep over 30 lines, this is a sign that it may have too many responsiblities and be broken up.
33-
34-
Avoid output arguments. These are arguments to functions that get changed by the function rather than having the fuction return a value. Users of your method may not expect the side effects as a result of passing that argument.
35-

0 commit comments

Comments
 (0)