智联海机器人程序注释与参数命名规范
看得懂比写得快重要
一段没有注释的程序，作者本人几周后也需要重新推导。规范的注释与命名不增加多少工作量，却决定程序能否被交接、被复用、被安全地修改。
三类注释怎么写
- 段头注释：说明这一段的功能、触发条件、结束条件和涉及的安全联动，四句话足够。
- 动作注释：在关键轨迹段和姿态切换处标注意图，例如接近、对位、撤离，而不是重复指令名称。
- I/O注释：写清信号来自哪里、代表什么状态、正常时是高电平还是低电平，避免只写编号。
参数命名规则
命名要能读出设备与用途两个信息：设备用统一缩写，用途用简短动词或名词，单位写进名字里，例如速度、延时、高度区分开。同一项目中不要混用拼音首字母、英文与无序编号三种风格。位置点在程序中应集中定义，不要在多个段里重复出现同一个坐标值。
让规范落地的做法
把注释与命名要求写进项目模板，新程序从模板起步；交接时随机抽查一段，请接手人复述逻辑，能讲通说明写得够清楚。程序改动后同步更新注释，是最容易被跳过也最值得坚持的一步。
