LabVIEW样式检查表4

发布于:2022-12-17 ⋅ 阅读:(382) ⋅ 点赞:(0)

LabVIEW样式检查表4

       以下是第四部分。

使用以下清单可帮助保持一致的样式和质量。用户可以自定义这些清单以适合应用的要求。

LabVIEW VIAnalyzer Toolkit提供了以交互方式或编程方式检查VI的风格、效率和LabVIEW编程其他方面的测试

LabVIEW Classes检查表

将所有类命名为名词。例如,将示例类命名为“波形读取器.lv 类”,而不是“读取波形”.lv 类。

在设计类时,请遵循其他编程语言的良好软件工程实践。

例如,避免从现有具体类继承一个具体类。相反,请创建一个抽象类作为两个具体类的公共父级。

将 LabVIEW  类 的所有 成员 VI 都 命名为 动词。例如,将示例成员命名为读取值 VI 而不是值 VI。

避免在 VI 名称中包含类的名称。例如,如果您将一个类命名为“特殊波形.lvclass”,并且有一个 VI 将两个这样的波形相加,请将该 VI 命名为“添加 VI”而不是“添加特殊波形 VI”。

使用单词“Read”作为严格从类的私有数据读取数据的任何VI的名称开头。避免使用“获取”一词或“获取”的任何同义词。

使用单词“Write”作为任何将数据严格捆绑到类的私有数据中的VI的名称开头。避免使用“设置”一词或“设置”的任何同义词。

考虑支持数据访问器VI的属性节点语法。但是,与没有错误终端的数据访问器VI相比,使用属性节点语法的访问器需要错误终端,并且在运行时导致的性能负担要大得多。评估并为每个类进行适当的选择。

将所有VI标记为私有,除非您有特定原因将其标记为公共,受保护或社区。

如果更改LabVIEW类线的接线外观,请避免创建过多的接线图案和颜色

程序框图窗口中颜色和图案的数量会影响LabVIEW代码的可读性。仅在必要时更改LabVIEW类导线的导线外观,以区分框图窗口中的其他类导线。

在类接线的外部使用深色,以提供与白色背景的对比度

如果类的私有数据仅包含引用类型,请对类连线使用标准引用颜色。在 LabVIEW颜色选取器的用户颜色对话框中找到名为Refnum线的颜色。

最佳做法要求任何包含一个引用类型的类只能包含作为元素的引用类型。尽管可以在类中混合包含数据值引用类型和按值类型,但当您在关系图上分叉接线时,这种混合可能会演示不明确的行为。数据值引用类型引用原始元素。按值类型创建原始元素的副本,而不是直接引用原始元素。混合这两种类型可能会导致令人困惑的行为。

标签和注释检查表

对所有终端使用可见且有意义的标签。

对包含不明显值的文档常量使用特定且详细的标签或附加注释。

使用透明标签。

对标签使用一致的大小写。

在标签中的单词之间使用空格。

避免使用重复的标签。

如果示例 SubVI  包含输入和输出对,则在控件中添加 in 的后缀,向显示添加  out 的后缀。例如,如果VI包含一个名为对象的“输入”,请将相应的输出命名为“对象输出”。

在输入中创建错误时,始终包含单词“in”。

使用括号记录控件或指示器的默认值和单位。

避免将括号用于任何其他目的。在大多数情况下,如果默认值与给定数据类型的默认值相同,则可以排除该默认值

在框图上附加自由标签来解释代码。使用自由标签来解释代码执行的原因,而不是代码的执行方式。

内容可能不清楚或令人困惑时,标签移位寄存器和接线。

一致地使用两种样式之一来放置终端标签。

对于第一种样式,将终端标签放在终端的左侧以用于控件,将终端标签放置在终端的右侧以用于指示器。

对于第二种样式,将终端标签左对齐在终端上方。在 VI、库或项目中一致地使用您选择的样式。

在自由标签中使用回车符仅用于分隔段落。

除非可用标签占用一行,否则请避免对这些标签使用“大小为文本”方法或属性。相反,应调整标签大小,以便所有文本都可见。此外,在可用标签的底部提供额外的空间,以考虑跨平台的字体大小变化。

在所有框图上使用标准应用程序字体进行自由标签。

在框图上使用应用程序字体,除非您有特定原因需要使用其他字体。

对所有注释使用默认的自由标签颜色。在 特殊 情况下,  您 可以 进行 例外, 例如 LabVIEW 2012 及 更高 版本 的 样本 项目。LabVIEW 2012 及 更高 版本 使用 新 样式 的 先例 来 显示 不同 类型 信息 的 注释

对于子关系图标签,请使用所有结构的默认外观,例如“case”和“事件”结构。

对于每个 VI(例如 API VI 和示例),专为第三方使用而设计,请在 VI 描述文本框中描述 VI 的作用。考虑在 VI 描述文本框中描述所有 VI。

要测试VI您为VI创建的文档VI,请编写并修改VI描述,并确认描述在上下文帮助窗口中正确显示。在“VI 属性”对话框的“文档”页面上的“VI 描述”文本框中描述如何使用 VI 和任何必需的参数设置。

检查“VI 属性”对话框以及前面板上所有单词的拼写和框图。

    需要说明的是,上述的例程和文档,都是可以下载的,双击即可打开,其中压缩文件是可以采用粘贴复制的方式,拷贝到硬盘上。这不是图片,各位小伙伴看到后尝试一下,这个问题就不用加微信咨询了。有关LabVIEW编程、LabVIEW开发等相关项目问题,可联系我们。

 

本文含有隐藏内容,请 开通VIP 后查看