今天学习了一位前辈写的脚本文件,总结一下收获吧.不是关于具体的代码,逻辑等等,只是来总结一下写脚本文件要注意的一些地方.
首先,引入的第三方库,要有一个大概的说明,库大致是用来做什么的(便于小白理解),如果能加上为什么要引入这几个库就很完美了.
用到了什么方法,要注释一下该方法的效果.
其次,脚本文件的参数以及输入最好在脚本文件开始的位置进行说明.最好包含参数类型,可能会传入的具体内容.
初识写脚本
最新推荐文章于 2024-05-16 18:20:04 发布
今天学习了一位前辈写的脚本文件,总结一下收获吧.不是关于具体的代码,逻辑等等,只是来总结一下写脚本文件要注意的一些地方.
首先,引入的第三方库,要有一个大概的说明,库大致是用来做什么的(便于小白理解),如果能加上为什么要引入这几个库就很完美了.
用到了什么方法,要注释一下该方法的效果.
其次,脚本文件的参数以及输入最好在脚本文件开始的位置进行说明.最好包含参数类型,可能会传入的具体内容.