哈工新欧液压测试台|labview组态编程的五大经验总结，助你开发过程事半功倍( 三 )
05不重视文档记录
优秀的代码文档可以有效地帮助他人理解自己写的程序 。 遗憾的是 ， 许多程序员通常在开发周期末期功能开发结束之后才开始进行文档撰写 。 这使得用于对代码进行文档记录的时间变得非常少 。 正确的做法应该是在开发过程中就需抽出时间来开始进行文档记录 。 文档对于编程人员自身也非常有用 ， 尤其是当他们过段时间回来看代码却不记得当初他们为什么选择某些代码时 。 程序员经常会一边喝着咖啡 ， 一边熬夜编程 ， 这往往会出现“短暂失忆” 。 而文档则可以帮助程序员进行回忆 。
一般情况下 ， 相对于基于文本的程序 ， LabVIEW的图形化特性使得程序阅读更为容易 ， 但是有效的文档记录可以减少“解码”程序所需的时间 。 添加文档注释到程序框图的最简单方式是使用自由标签 。 您可以在框图的空白位置双击左键 ， 并输入文字 ， 添加注释 。 然后 ， 使用箭头标记来指向自由标签引用的特定代码 。 如果需要添加图片 ， 则可将它们复制到剪贴板 ， 然后粘贴到程序框图中 。 物理系统图片和数学公式均有助于清晰说明程序框图内的代码上下文 。
本文插图
架构正确且文档记录充分的代码不仅可帮助其他人理解您的代码 ， 也可帮助您更好地理解自己的代码 。
对代码进行文档记录不仅只是针对复用程序库 ， 而应该是针对每一个程序 。 当一个人需要为其他人讲解时 ， 他对该主题将会有更深刻的理解 。 文档记录从本质上看就是在迫使程序员进行讲解 ， 以帮助他们更好地了解自己的代码 。
推荐阅读
- 测评玩转花式种草，西五街，能把美妆测试安利给Z时代吗？
- SD-WAN观脉科技AllWAN 和Linker通过中国“SD-WAN Ready”测试，助力SD-WAN行业标准化
- 蓝鲸财经记者工作平台|消息称台积电拟投资101亿美元新建芯片封装与测试工厂
- 界面新闻|中消协和深圳消委会测试多款运动鞋未达标，耐克、阿迪达斯和李宁“中招”
- 音频|iOS测试版系统出现Apple News+音频版相关内容
- 封面新闻|四川内江将于6月正式开始国家毫米波雷达无线电外场测试
- 硅谷密探|SpaceX载人航天发射，宇航员手动操纵龙飞船进行测试！
- 爆炸突发：马斯克星舰原型机测试过程中爆炸，猎鹰载人上天蒙上阴影
- 马斯克马斯克的星际飞船原型机在得州测试时爆炸
- 安兔兔跑|10部手机安兔兔跑分测试：都是骁龙865处理器差距比想象要大