请选择 进入手机版 | 继续访问电脑版

苏州实操派科技有限公司官网-实操派教育科技,汇川技术PLC培训,实操派PLC培训,苏州PLC培训机构

ST文本编程:如何正确编写注释?

[复制链接]

附件下载,需登录可以查看贴内更多信息

您需要 登录 才可以下载或查看,没有账号?立即注册

x
文章大纲:
一、ST文本编程简介
二、注释的重要性和作用
三、注释的规范化要求
  1. 注释的位置和格式要求
  2. 注释内容的要求
四、正确编写注释的方法和技巧
  1. 简洁明了
  2. 具体详细
  3. 规范统一
  4. 实用可读
五、常见的注释错误及相应的解决方法
  1. 中英文拼写错误和标点符号错误
  2. 描述不准确或不完整
  3. 注释内容过度或过少
  4. 注释过于模糊或含糊不清
六、总结
七、参考文献

一、ST文本编程简介
ST(Structured Text)结构化文本语言,是IEC61131-3国际标准中定义的其中一种编程语言。它是工业自动化中广泛使用的一种编程语言,适用于PLC编程、机器人编程等领域。

二、注释的重要性和作用
注释是给程序员自己及其他人看代码时提供帮助以理解程序逻辑的叙述性语句。注释的目的在于提高代码的可读性,使代码更容易理解和维护。好的注释可以使代码更具可读性、可维护性和复用性。

三、注释的规范化要求
1、注释的位置和格式要求:
注释需紧跟在程序语句之后,不允许出现在程序语句上方。注释前需有空格,注释后不需要空格。注释符号“//”需与注释内容之间有一个空格。
2、注释内容的要求:
注释内容应该准确、全面、简洁、明了、规范统一,尽量使用英文代替中文。

四、正确编写注释的方法和技巧
1、简洁明了:
注释要简练明了,不要太长,保持注释和代码一致。一般情况下,注释最好控制在200个字符以内。
2、具体详细:
注释要具体,说明此处进行了什么操作,缺少具体描述的注释是没有意义的。并且,注释要包括参数的含义、返回值的含义、函数的作用等详细信息。
3、规范统一:
注释应该符合特定的样式和格式,保证在团队协作中注释格式的一致性。
4、实用可读:
注释应该能够帮助程序员快速理解代码逻辑,注释必须要写得良好。通过使用足够的空白和标题,注释可以被更容易地浏览和理解。

五、常见的注释错误及相应的解决方法
1、中英文拼写错误和标点符号错误:
注释对于代码的理解起着至关重要的作用,因此应该避免出现简单的拼写和标点符号错误。
2、描述不准确或不完整:
注释应该包含足够的信息和清晰的描述,以便让其他人理解你的程序。如果注释描述不准确或不完整,则需要修改并维护注释。
3、注释内容过度或过少:
过度的注释会使代码难以阅读,而过少的注释则不能提供足够的信息。因此,应该适当地添加注释,使得代码易于理解和维护。
4、注释过于模糊或含糊不清:
注释应该是清晰和具体的,特别是在处理复杂的代码时。如果注释过于模糊或含糊不清,那么注释就是没有意义的。

六、总结
对于ST编程语言来说,注释是非常重要的,因为它可以帮助程序员和队友更好地理解代码逻辑,从而提高代码的可读性和可维护性。编写注释时,应该注重简洁明了,具体详细,规范统一,实用可读。

七、参考文献
1.《PLC编程技术》
2. 《IEC 61131-3》

________________________________________________________________________

免责声明:本文非官方发布,内容真实性请注意甄别,文章内容仅供参考。本站不对内容真实性负责,请悉知!本站不对内容真实性负责,请悉知!。我们专注于汇川技术产品培训,官网https://shicaopai.com

相关帖子

回复

使用道具 举报

shicaopai 2023-5-25 04:58:53 | 显示全部楼层
ST文本编程:如何正确编写注释?

一、ST文本编程简介
ST(Structured Text)结构化文本语言,是IEC61131-3国际标准中定义的其中一种编程语言。它是工业自动化中广泛使用的一种编程语言,适用于PLC编程、机器人编程等领域。ST编程是一种类似于C语言的结构化文本编程方法,通过使用可读性高的文本来编写程序。

二、注释的重要性和作用
注释是给程序员自己及其他人看代码时提供帮助以理解程序逻辑的叙述性语句。注释的目的在于提高代码的可读性,使代码更容易理解和维护。好的注释可以使代码更具可读性、可维护性和复用性。

三、注释的规范化要求
1、注释的位置和格式要求:
注释需紧跟在程序语句之后,不允许出现在程序语句上方。注释前需有空格,注释后不需要空格。注释符号“//”需与注释内容之间有一个空格。
2、注释内容的要求:
注释内容应该准确、全面、简洁、明了、规范统一,尽量使用英文代替中文。

四、正确编写注释的方法和技巧
1、简洁明了:
注释要简练明了,不要太长,保持注释和代码一致。一般情况下,注释最好控制在200个字符以内。
2、具体详细:
注释要具体,说明此处进行了什么操作,缺少具体描述的注释是没有意义的。并且,注释要包括参数的含义、返回值的含义、函数的作用等详细信息。
3、规范统一:
注释应该符合特定的样式和格式,保证在团队协作中注释格式的一致性。
4、实用可读:
注释应该能够帮助程序员快速理解代码逻辑,注释必须要写得良好。通过使用足够的空白和标题,注释可以被更容易地浏览和理解。

五、常见的注释错误及相应的解决方法
1、中英文拼写错误和标点符号错误:
注释对于代码的理解起着至关重要的作用,因此应该避免出现简单的拼写和标点符号错误。
2、描述不准确或不完整:
注释应该包含足够的信息和清晰的描述,以便让其他人理解你的程序。如果注释描述不准确或不完整,则需要修改并维护注释。
3、注释内容过度或过少:
过度的注释会使代码难以阅读,而过少的注释则不能提供足够的信息。因此,应该适当地添加注释,使得代码易于理解和维护。
4、注释过于模糊或含糊不清:
注释应该是清晰和具体的,特别是在处理复杂的代码时。如果注释过于模糊或含糊不清,那么注释就是没有意义的。

六、总结
对于ST编程语言来说,注释是非常重要的,因为它可以帮助程序员和队友更好地理解代码逻辑,从而提高代码的可读性和可维护性。编写注释时,应该注重简洁明了,具体详细,规范统一,实用可读。

七、参考文献
1.《PLC编程技术》
2. 《IEC 61131-3》
                                                                                                                                                                                                                                                 以上内容来自  AI机器人,如需继续对话,则在此回答下“点击回复” 或者 在提问时  “@机器人”!禁止 "黄赌毒及政治敏感",违者封号,严重者 提交 网警公安部门。本站不对内容真实性负责,AI机器人有时候会乱说一通……
回复

使用道具 举报

data/attachment/temp/202212/30/133743h8cd9z14sjs84kaz.png_thumb.jpg 共30章节500课时

【全科班】汇川中型PLC从0到1就业班(Codesys系统化全科班课程-600节+)-汇川PLC教程

朱子文

¥ 4699.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20240206/VMdEZiqp3BMkbBIlMRRD.png 共9章节44课时

【09-Codesys教程】电子凸轮齿轮从入门到进阶系统化课程-色标跟踪-探针-追剪-飞剪-间歇式工艺-汇川中大型PLC伺服多轴同步运控

朱子文

¥ 699.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20240217/v39r666Z663eBBGKErRm.png 共31章节487课时

【全科班】汇川技术H5U从0到1就业班(系统化全科班-600节+)

张汉清

¥ 4199.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20240206/Fu5pu34pPcTpu0La443P.png 共6章节52课时

【10-Codesys】包装行业-三伺服枕包机实战项目(4虚轴3实轴耦合+凸轮动态修改+防切工艺+防空工艺+色标探针+挺杆功能+状态机编程+程序框架+指针FIFO)

朱子文

¥ 899.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20240207/HlL5SWHry9lPVdqC8i59.png 共5章节63课时

【01-Codesys教程】ST文本从0到1,从入门到进阶-汇川中大型PLC教程

朱子文

¥ 499.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20240206/Su1ibr3I77yl78DLBR7D.png 共4章节29课时

【12-Codesys小课】中大型PLC-PID控制器算法从入门到进阶之液位控制系统

朱子文

¥ 699.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20230603/Cz3hqDmDD8qHfT3MDm4m.png 共3章节30课时

【05-Codesys教程】汇川中大型PLC单轴运动控制教程-汇川PLC教程

朱子文

¥ 399.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20230603/gXpEpJ8Qb78eD5lDqlnQ.png 共3章节25课时

【06-Codesys教程】汇川中大型PLC运动控制进阶篇(多轴PTP)-编程框架与编程模板实操

朱子文

¥ 499.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20240206/e39s63ppg54Q2s5H33H9.png 共3章节24课时

【08-codesys教程】汇川中大型codesys教程-多轴运控扩展篇经验分享小知识分享

朱子文

¥ 299.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20240206/Mvb3O7wWw5d3D5WND27g.png 共5章节28课时

【04-汇川伺服】汇川技术SV660系列伺服基础入门课程

朱子文

¥ 199.00
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

data/attachment/temp/202212/30/133743h8cd9z14sjs84kaz.png_thumb.jpg 共30章节500课时

【全科班】汇川中型PLC从0到1就业班(Codesys系统化全科班课程-600节+)-汇川PLC教程

朱子文

¥ 4699.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20240206/VMdEZiqp3BMkbBIlMRRD.png 共9章节44课时

【09-Codesys教程】电子凸轮齿轮从入门到进阶系统化课程-色标跟踪-探针-追剪-飞剪-间歇式工艺-汇川中大型PLC伺服多轴同步运控

朱子文

¥ 699.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20240217/v39r666Z663eBBGKErRm.png 共31章节487课时

【全科班】汇川技术H5U从0到1就业班(系统化全科班-600节+)

张汉清

¥ 4199.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20240206/Fu5pu34pPcTpu0La443P.png 共6章节52课时

【10-Codesys】包装行业-三伺服枕包机实战项目(4虚轴3实轴耦合+凸轮动态修改+防切工艺+防空工艺+色标探针+挺杆功能+状态机编程+程序框架+指针FIFO)

朱子文

¥ 899.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20240207/HlL5SWHry9lPVdqC8i59.png 共5章节63课时

【01-Codesys教程】ST文本从0到1,从入门到进阶-汇川中大型PLC教程

朱子文

¥ 499.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20240206/Su1ibr3I77yl78DLBR7D.png 共4章节29课时

【12-Codesys小课】中大型PLC-PID控制器算法从入门到进阶之液位控制系统

朱子文

¥ 699.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20230603/Cz3hqDmDD8qHfT3MDm4m.png 共3章节30课时

【05-Codesys教程】汇川中大型PLC单轴运动控制教程-汇川PLC教程

朱子文

¥ 399.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20230603/gXpEpJ8Qb78eD5lDqlnQ.png 共3章节25课时

【06-Codesys教程】汇川中大型PLC运动控制进阶篇(多轴PTP)-编程框架与编程模板实操

朱子文

¥ 499.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20240206/e39s63ppg54Q2s5H33H9.png 共3章节24课时

【08-codesys教程】汇川中大型codesys教程-多轴运控扩展篇经验分享小知识分享

朱子文

¥ 299.00
https://shicaopai-video-files.oss-cn-hangzhou.aliyuncs.com/keke_video_base/image/20240206/Mvb3O7wWw5d3D5WND27g.png 共5章节28课时

【04-汇川伺服】汇川技术SV660系列伺服基础入门课程

朱子文

¥ 199.00

到"π³ 实操派",学PLC就是快!汇川及Codesys业务培训

项目实战 手把手教学 微信&电话 15850116008
线上26章系统化课程,汇川优秀自动化讲师,亲力打造 π³ 实操派教培品牌,让你快速系统化掌握项目实战编程能力;仅剩少量名额
点击免费试听

到实操派,学PLC就是快!

扫码领取工控文库VIP

钻石VIP先到先得

服务电话 & 微信:9:00-22:00

15850116008

苏州实操派科技有限公司

公司地址:江苏省苏州市吴中区越溪街道天鹅荡路5号31B13

Copyright © 苏州实操派科技有限公司 2022 到实操派,学PLC就是快!工业自动化业务培训适用人群:成人 ( 苏ICP备2022021576号-3 )|网站地图

公司地址:江苏省苏州市吴中区越溪街道天鹅荡路5号31B13

返回顶部