client/doc/CodingStyle

   1                         客户端编码风格(Coding Style For XylFTP client)
   2
   3                                                                 作者：王聪
   4
   5 1. 类名，类成员名，类方法名，参数名
   6
   7 这些名字都应该是有意义的，一些缩写是鼓励使用的，但至少应该让人看了能大体知道它表示的意思。
   8 如果名字由多个单词组成，通过大写第一个字母来分界（第一个单词的第一个字母应该永远大写）。比如：
   9
  10 class MyName{
  11         private String Name;
  12         public void SetName(String NewName){
  13                 ...
  14         }
  15         ...
  16 }
  17
  18 而不是
  19
  20 class myname{
  21         private String name;
  22         public void setName(String newName);
  23         ...
  24 }
  25
  26 同样，myName和my_name也是不赞成使用的风格。
  27
  28 常用缩写如全为大写，则保持不变，例如XylFTPCLI要比XylFtpCli要好。
  29
  30 注意：函数内部自己定义的局部变量可以不受这些条件的制约。
  31
  32 2. 花括号
  33
  34 一对花括号的前一半（{）应该紧跟它附属的语句，声明等，而后一半（}）应该和此语句开始对齐。比如：
  35
  36 if (ThisIsTrue) {
  37         ....
  38 } else {
  39         ...
  40 }
  41
  42 而不应该是
  43
  44 if (ThisIsTrue)
  45 {
  46         ...
  47 }
  48 else
  49 {
  50         ...
  51 }
  52
  53 3. 注释
  54
  55 除为javadoc生成文档用的注释外，其它一律采用//风格的注释。
  56
  57 编写javadoc注释时可参考下面的文章：
  58 http://hedong.3322.org/archives/000242.html
  59
  60 4. 缩进
  61
  62 缩进一律采用8个空格宽度的tab，请正确设置自己的编辑器，并且注意，不要让你的编辑器把tab替换为连续的空格。
  63 需要额外指出的是switch语句，它里面的case应该和switch对齐，比如：
  64
  65 switch (Status) {
  66 case 1:
  67         ...
  68         break;
  69 case 2:
  70         ...
  71         break;
  72 default:
  73         ...
  74 }
  75
  76 5. 空白
  77
  78 用空格分隔如下关键字：
  79 try, catch, if, else, else if, for, while, switch
  80
  81 除了判断相等的操作符之外，操作符和操作数之间最好也用空格分开，比如：
  82
  83 if (i==1 && p!=null) {
  84         i = j;
  85         String foo = "";
  86         foo = foo + p;
  87 }
  88
  89 6. 进一步阅读
  90
  91 关于Java编码风格，下面这篇文章做了更仔细的介绍：
  92 http://www.welog.org/blog/44
  93
  94 对编程风格更深入的介绍可参考：
  95 1. Brian W. Kernighan and Rob Pike, The Practice of Programming, Addison-Wesley, 1999.
  96 2. W. Kernighan and PJ Plauger, The Elements of Programming Style,  2nd Edition, Computing Mcgraw-Hill, 1978.
  97
  98