论坛推荐：怎样写出好的脚本-流程的开发与建立

admin

我不是专业的程序员，我也没有太固定的coding style，只是最近在写一个utility，有些许感想，加上在之前网上收集了一些参考资料，遂想整理出来，以享需要之同志。
: g5 l9 k* V6 O这个系列暂时还没想好写多少，目前有以下几个议题，在此基础上展开来写：
" @# l  P7 p3 L9 a7 R4 R

3 t5 e1 h  L$ s2 Z# }, @6 G( C
• 脚本流程的开发与建立（本文）
  $ `- X6 Z& e* o# h. j
• 降低维护成本需要的好习惯
  3 X) \8 J4 U! M9 y7 G0 l0 t
• 权衡流程自动化与深入学习之间的矛盾
  

今天开始将第一个议题：流程的开发与建立

flow chart

" U) E$ J# I3 ~

我是做IC的，大规模集成电路，在我们行业里，一切按流程办事早已成为一种共识，主要是因为集成电路的生产工艺要求很高，生产成本巨大，技术门槛相对较高（专业化），开发周期相对较长（相对传统制造业）。


% `! S0 ]% N: q1 L6 b" M4 dEDA工具都有一套行之有效地参考flow，每家公司都会开发一些flow和工具，来提高员工的工作效率，标准化开发手段。那么怎样的flow才是一个好的flow呢？大家的意见都是不同的，我只是管中窥豹地讲下我认为的好flow是怎么样子的。
请看图（原创，如需引用请表明出处）：
, x9 x4 j1 S1 d8 D
5 k3 J. q0 k+ C9 `8 w

- G4 G: ~0 B; c  y8 E
• flow是最外层与用户交互的部分，接受用户的输入，给予用户输出结果
  
• flow与核心的工具没有关系，flow行驶的是管理和后勤之类的事情，而真正生产线上是生产汽车还是生产iphone，这对于flow来说没有差别
  
• flow中应该要包含项目管理和时间控制等等子模块，这些子模块本身可能也是一个比较复杂的过程
  
• 确定执行具体功能脚本的机制，尽可能降低维护成本
  

对于Tcl来做flow controller，以下两种方式的调用子功能的方法做个比较:
5 |# ^. P! L" H+ J— proc 实现子功能
4 k* h& ?: s% U) H1 X

2 \: `7 \- M& }$ l  t3 U) }
• 作用域不明确，需要不断切换，EDA工具的所有配置都是在global domain里的，proc封装之后经常会发生作用域不明确，给开发带来额外的负担
  , s. |- Z8 q3 z  x3 x
• 方便管理，责任明确
  # }, `: X6 Z( K9 C  B! u
• 更新维护方便
  
• 复用性强
  

1 l$ R7 d0 a# _  W3 X- N— eval 运行子功能模块
# y3 a3 z. a0 i) t- _7 w: E" V

5 q  @6 n$ ^; {  A: A) j  M
• 运行排错滞后，不能在source的时候就发现一些code上的基本错误
  
• 所有功能模块都是在global域内执行的，功能模块中使用到的变量的作用域被扩大
  
• 开发调试上的便利
  . A7 a9 f% H! f
• 可复用
  
• 使用wrapper的方式运行具体脚本，便于流程的建立
  

* E: J- ~4 s2 D4 z/ G' o: w由于eval的第三条，我采用的是eval来运行具体的功能模块，相当于给具体的脚本加了一层wrapper，可以做到flow与具体功能脚本隔绝开来，能更好地对flow之外的过程进行详细的控制。
, x% M# H3 R- y对于方便管理和责任明确，维护方便等优点，我自建了一套debug系统，自己建立数据联系，将脚本管理，维护方式，错误报告等统一起来。
而复用这个问题上，eval的确没有proc来得强，也不可能做到封装，而灵活性本来就是eval的优点，这个要有所取舍了。
我编写的这个flower cotrolloer有如下特性：
, J  }+ m8 p" S5 _- G

• 读取excel做为配置文件，实则是转换为ASICII文件后做为flow cotroller的配置文件；
  
• 每个子功能模块需要的信息都定义在配置文件中，包括维护者，各种特性，有flow cotroller读取并存储在变量里；
  & C# W6 |7 b3 Y% I  y' G+ W, j( V
• 有自己的message system，定义多种message的级别；
  
• 输入信息的总体check，有不合理的return并给出解决办法；
  0 }; R, F& t7 `" C# J# t9 ]: t4 V
• 每个子功能模块有tag机制，方便扩展后续功能；
  % S9 _, Z& ?9 y4 {1 ]$ ^' R
• 子模块出错，自动发送mail给维护者，抄送当前用户并记录出错时的error message和所有相关变量的值
    b# x" c* s' A+ e3 z
• 监控子模块的运行时间runtime
  
• flow run结束有mail提醒，mail中有概要的运行结果信息
  
• 最终结果以网页的形式发布
  . ^, I. O( a5 E0 G
• 使用list来代替bool输入
  . _* n% M; q/ Q6 |4 L, T3 [
• 适用于ICC/EDI并可以支持其他工具
  
• 预留了prerun和postrun的接口
  
• 各种模式切换的接口
  . r5 u; w- F1 o9 O

这些事主要功能，还有很多贴心的小地方在用户的不断测试中在完善。
分享一个Tcl运行cmd set的wrapper ：整套cmd set包含exeCmdSet, msgCmdSet, cfgCmdSet三个命令和一个全局数组变量varCmdSet。

• 可接受数据输入
  $ T, v7 L& |( {4 N& M: i' Z
• 计算runtime
  
• mute消息
  
• 自定义array
  3 q7 D  y" C* D

?Download execmdset.proc
7 `* U& j% v. p0 i; J

• proc exeCmdSet {args} {
  8 C; C6 z% w3 Y3 H9 F7 A7 w4 d; h
  
• 
  ( |4 G$ @1 F8 U- D) U, S8 M
  
• global varCmdSet ;
  
  : d6 H+ z# ~5 k! V
• my_parse_proc_arguments -args $args alist ;
  
  . ?6 Q$ Y. X5 G% Y: A8 f9 @
• ...
  * U4 ]- @3 {- N% \8 n$ H; u' R. F
  
• }
  # U& \" N& R5 s/ I  \
  2 u) V5 L2 B/ o  j
• my_define_proc_arguments exeCmdSet -info "Evaluate tasks defined in -array, default is strCmdSet" \
  
  
• -define_args {
  2 J) ]" K7 O# c6 H  l/ Y0 I
  
• {task     "Name of tasks" tasks list required}
  
  3 [8 J+ @2 @$ u- T0 N% l
• {-nomsg   "Boolean to control the stdout msg" "" boolean optional}
  
  
• {-array   "Array to exec" array string optional}
  . \8 L( K  E) @- ~
  . i7 \1 U9 {$ y: y+ J5 _6 ?/ D
• {-runtime "Calculate the runtime" "" boolean optional}
  
  1 }! I3 U) P+ J. ^/ S0 u/ z: c- c
• {-data    "Data store in varCmdSet" data list optional}
  
  5 ]* V( q, x2 q# t
• }
  ' F+ d2 e, S% L; p/ w- p8 u' I

复制代码