培训代码操作的几点思考

image.png

最近两周在给同事交接工作的时候遇到了一些困难,不过都统统解决掉了,不过还是让我心有余悸,若不是自己未雨绸缪 提前在代码上 下了一些功夫 ,不然不可能在极端时间内 解决多个棘手的问题如此顺利抽身而出,以下几点 都是这次给我的教训,以前没有看重的,也在这次给自己一个响亮的耳光
1.你的项目一定要整洁,什么功能的脚本文件在什么目录要清楚,命名要绝对清楚

2.你的项目 每个文件 的每个函数都要写清楚 注释,并把每个函数的参数的释疑 数据类型都写明白,每个文件 要声明作者和日期

3.你的每个类文件 都应该有日志声明,每个函数的执行都应该有日志输出,重要的变量 值要做到输出到console中来

4.你的项目至少要有一个README文件 ,告诉别人 这个项目是在做什么,操作的前提 需要配置好什么环境,操作的入口类 、函数在哪里,整个项目的树状结构

5.项目要交由 git 来做版本控制

6.项目要有单元测试

7.每个函数要有前瞻性,把入参写全了,调用的时候也把入参写全,写好默认值,

8.对于上传 下载 的函数 要区分 Windows 和mac 的文件目录分隔符不同

9.项目要不断优化重构,使函数尽可能的解耦,更灵活的组装配置

10.项目一定要有配置文件,敏感信息要配置在配置文件中,是脚本尽可能的不受具体参数的污染

11.对于函数执行结果 在不能确认时,要用最笨的方式去检验结果

12.对于给不在同一个空间场地的同事培训,要借助使用teamviewer 远程操控对方机器,协助对方操作

13.在给对方培训原理后,一定要监督其操作,因为还会在操作中出现问题

14.对Linux shell 命令要足够熟练 ,通过系统来检验问题

这次给同事培训,一个是 路径写错了 ,一个是Windows的开机密码不可以用来ssh登录,之后是 Windows的分隔符导致 文件上传异常,最后是 上传因为 两台电脑的用户在ssh登录时没有进行过首次相互登录,导致对方相互不认识,无法上传,所以只要,双方认识了,这个就可以正确上传,再给同事培训时 不断感叹,若不是有充足的日志输出,不然非常困难定位问题,若不是项目写的简洁整洁,不然找文件 函数也非常困难,若不是有注释,不然早忘记每个函数的到底含义是什么,若不是重构解耦足够灵活不然 在解决bug时 不再写新的函数,导致更复杂的背景下,修改局部就可以解决,若不是对Windows 目录分隔符有前瞻性预判,留了 对其修改的余地,不然项目修改会非常巨大,若不是自己对shell操作熟练,不然也不可能用最笨的方法判断问题是否被解决

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,386评论 6 479
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,939评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,851评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,953评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,971评论 5 369
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,784评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,126评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,765评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,148评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,744评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,858评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,479评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,080评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,053评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,278评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,245评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,590评论 2 343

推荐阅读更多精彩内容