一、变量

取有意义的名字，不要用简称，简写
给变量适当增加注释

二、注释

必须要写注释，而且是好的注释，不好的注释，宁愿不要，代码更新后，记得更新注释
注释包括：包的注释、代码文件注释、代码块注释、函数注释、变量注释。

三、文档

保管好你的需求文档、api文档、修改文档。
程序、数据、文档按照项目（版本）分别存储

四、函数

多写函数，不要试图用一个冗长的脚本就能解决所有问题
函数不要写太长，理论上越短越好，不然两个礼拜后回头修改你会懵
函数名字好懂
写注释：这个函数是做什么的，它有哪些输入参数，它有哪些输出参数......函数内部，功能完备的代码块之间记得空行
写log：函数版本，或者修改记录，不让容易混淆
写测试代码：把测试代码也写到document里面
用到的参数，都列出来，以便增加函数的【纯度】，不然，将来用多线程优化时，会有数据竞争的隐患，你会莫名其妙
每个函数都要有测试代码

我觉得一个比较好的julia代码文件，应该如下
1、注释完备
2、除了变量，其它流程操作都写入函数
3、写一个main函数，把流程组织起来。好处是让人一目了然，知道整体处理过程，而不会迷失在一片代码的海洋里

"""
整个文件的说明
功能：
版本：
维护：
其它：比如写上对应的需求文档等等
"""

"""
变量注释
"""
name = "zbq"

"""
变量注释
"""
age = 20

"""
函数注释
功能：
输入：
输出：
版本、维护信息：
"""
function fn1() 
    #代码
end

"""
函数注释
功能：
输入：
输出：
版本、维护信息：
"""
function fn2() 
    #代码
end

"""
函数注释
整体流程
"""
function main()
    #第一步：。。。。。
    #代码
    
    #第二步：。。。。。
    #代码
end

main()

五、用好module包

module可以让你隔离函数和变量，并用来组织和管理你的整个程序（软件），你可以根据功能，创建对应的module，把相关的函数和变量放在不同的包里。
如果你还没用过的话，赶快用起来，写代码不是写诗歌，写散文。程序庞大之后，你会一脸懵。

===小提示===

每个模块，功能独立，有【输出】，有【输出】，可以独立运行，好处就是，方便测试、方便调试、方便集成

如下图，为一个模块的代码文件构成

包含变量和函数，其中为了预留变量的访问接口，每个变量可以配置上set和get方法
如下所示，每一个变量，配上一堆get和set属性方法，注意set里面用【global】

name = "zbq"
function get_name()
    return name
end

function set_name(name_val)
    global name = name_val
end

image.png
image.png

从其他模块调用子模块
1、加载模块【加载包】
2、初始化模块。【使用get,set函数】
3、执行模块的功能。【调用run()】