[SE] 如何编写好的代码

1. 综述
   
• 良好的代码规范，包括文件名规范
• 良好的源代码目录结构
• 模块化
• 规划实现某种功能需要划分成几个模块（或者用几个函数实现），各模块之间如何交互
  
• 公用代码要提取出来作为单独的模块
  
• 评价要点
  (Ref: )
  
• 健壮性
  在异常情况下，软件能够正常运行的能力。健壮性有两层含义：一是容错能力，二是恢复能力
  
1. 容错是指发生异常情况时系统不出错误的能力
2. 恢复能力是指软件发生错误后重新运行时，能否恢复到没有发生错误前的状态的能力
• 可靠性
  在一定环境下，在给定的时间内，系统不发生故障的概率
• 性能
  软件的“时间—空间”效率。可以通过优化数据结构、算法和代码来提高软件的性能
• 可扩展
  反映软件适应“变化”的能力。在软件开发过程中，需求、设计、算法的改进、程序本身都有可能变化，软件是否容易修改关键看它的规模和复杂性
• 易用性
  用户使用软件的容易程度。它直观体现为“界面友好”、“方便”等
• 安全性 （涉及到用户隐私等重要数据考虑的较多，如银行账号等）
  是指防止系统被非法入侵的能力，既属于技术问题又属于管理问题。
• 兼容 （网络应用程序考虑的较多）
  两个或以上的软件相互交换信息的能力。开发某领域的新软件，应与已流行的软件相兼容，否则难以被市场接受
• 可移植 （考虑的较少）
  软件运行于不同软硬件环境的能力。编程语言越低级，程序越难移植。
• xxx
  
• xxx
  
2. 如何编写好的函数
• 规划如何返回结果
• 通过参数
• 通过函数返回值
• 如何区别正确和错误的返回结果
  
• 检查输入参数
• 函数返回前释放所有资源
• 分配的内存
• 打开的文件
• 建立的连接（Socket等）
• 打开的管道
• ...
  
• 异常处理
• 调用的函数返回错误
• 调用的函数抛出异常
• 内存越界
1. 栈越界（如递归调用等）
2. 堆空间不足（内存分配失败）
3. 内存拷贝越界
4. 数组访问越界
   
• xxx
  
• 多线程处理
  
• 多线程之间的并发和同步
1. 保护共享资源
2. 避免死锁
3. 避免状态混乱
   
• xxx
  
• 逻辑清晰
• 对于晦涩的地方，一定要加注释，说明为什么要这么作，功能是什么。但注意:注释必须准确，有意义，否则还不如不写。
  
• 删除冗余
• 删除不必要的代码，包括注释。如果你觉得代码在以后还可能用到，你完全可以通过版本控制系统找回来
• 调整代码结构/顺序，降低代码量
  
• 多测试
  
• xxx
  
3. 怎样设计UI
• 不要阻塞主线程 (Term: I) Hang, Freeze. II) take too long to process , a time-consuming operation, long-running computing)
  
• 长操作（一般超过10s的操作）应该在另外的线程中处理
• 主线程里不要调用 semaphore.wait, sleep 等函数
  
• 不要打断用户
• 如果你的程序在后台运行，不要弹出(spawn)对话框
• 可以在Status Bar显示一些通知（icon and/or texts)
  
• 最好能适应各种分辨率的屏幕
• 使用MVC架构
  
• xxx
  
4. xxx