📄 编码规范_vb.htm
字号:
style='font-size:9.0pt;font-family:"\000B ";color:black'>s</span><span
style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>、</span><span lang=EN-US
style='font-size:9.0pt;font-family:"\000B ";color:black'>g </span><span
style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>和</span><span lang=EN-US
style='font-size:9.0pt;font-family:"\000B ";color:black'> m </span><span
style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>这样的前缀对于理解一个常量的值和范围还是很有用的。对于常量名，应遵循与变量相同的规则。例如：</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
<br>
mintUserListMax '</span><span
style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>对用户列表的最大限制</span><span lang=EN-US
style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
'(</span><span
style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>整数值，本地到模块</span><span lang=EN-US
style='font-size:9.0pt;font-family:"\000B ";color:black'>)<br>
gstrNewLine '</span><span
style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>新行字符</span><span lang=EN-US
style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
'(</span><span
style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>字符串，应用程序全局使用</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'>)<br>
<br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>变量</span><span lang=EN-US
style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>声明所有的变量将会节省编程时间，因为键入操作引起的错误减少了（例如，究竟是</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'>
aUserNameTmp</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:
"\000B ";mso-hansi-font-family:"\000B ";color:black'>，还是</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'>
sUserNameTmp</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:
"\000B ";mso-hansi-font-family:"\000B ";color:black'>，还是</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'>
sUserNameTemp</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:
"\000B ";mso-hansi-font-family:"\000B ";color:black'>）。在“选项”对话框的“编辑器”标签中，复选“要求变量声明”选项。</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'>Option
Explicit </span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:
"\000B ";mso-hansi-font-family:"\000B ";color:black'>语句要求在</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'> Visual
Basic </span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:
"\000B ";mso-hansi-font-family:"\000B ";color:black'>程序中声明所有的变量。</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
<br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>应该给变量加前缀来指明它们的数据类型。而且前缀可以被扩展，用来指明变量范围，特别是对大型程序。</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
<br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>变量数据类型</span><span lang=EN-US
style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>用下列前缀来指明一个变量的数据类型。</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
<br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>数据类型</span><span style='font-size:
9.0pt;font-family:"\000B ";color:black'> </span><span style='font-size:9.0pt;
font-family:宋体;mso-ascii-font-family:"\000B ";mso-hansi-font-family:"\000B ";
color:black'>前缀</span><span style='font-size:9.0pt;font-family:"\000B ";
color:black'> </span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:
"\000B ";mso-hansi-font-family:"\000B ";color:black'>例子</span><span lang=EN-US
style='font-size:9.0pt;font-family:"\000B ";color:black'> <br>
Boolean bln blnFound <br>
eanB byt bytRasterData <br>
nByteCollection o col colWidgets <br>
ection o cur curRevenue <br>
on objectCu dtm dtmStart <br>
ectCur dbl dblTolerance <br>
Curre err errOrderNum <br>
rencyDa int intQuantity <br>
yDat lng lngDistance <br>
Object obj objCurrent <br>
ectSin sng sngAverage <br>
Single str strFName <br>
gleStringUser-def udt udtEmployee <br>
User-de vnt vntCheckSum <br>
<br>
<br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>描述变量和过程名</span><span lang=EN-US
style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>变量或过程名的主体应该使用大小写混合形式，并且应该足够长以描述它的作用。而且，函数名应该以一个动词起首，如</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'>
InitNameArray </span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:
"\000B ";mso-hansi-font-family:"\000B ";color:black'>或</span><span lang=EN-US
style='font-size:9.0pt;font-family:"\000B ";color:black'> CloseDialog</span><span
style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>。</span><span lang=EN-US
style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
<br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>对于频繁使用的或长的项，推荐使用标准缩略语以使名称的长度合理化。一般来说，超过</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'> 32 </span><span
style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>个字符的变量名在</span><span lang=EN-US
style='font-size:9.0pt;font-family:"\000B ";color:black'> VGA </span><span
style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>显示器上读起来就困难了。</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
<br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>当使用缩略语时，要确保它们在整个应用程序中的一致性。在一个工程中，如果一会儿使用</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'> Cnt</span><span
style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>，</span><span style='font-size:
9.0pt;font-family:"\000B ";color:black'> </span><span style='font-size:9.0pt;
font-family:宋体;mso-ascii-font-family:"\000B ";mso-hansi-font-family:"\000B ";
color:black'>一会儿使用</span><span lang=EN-US style='font-size:9.0pt;font-family:
"\000B ";color:black'> Count</span><span style='font-size:9.0pt;font-family:
宋体;mso-ascii-font-family:"\000B ";mso-hansi-font-family:"\000B ";color:black'>，将导致不必要的混淆。</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
<br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>用户定义的类型</span><span lang=EN-US
style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>在一项有许多用户定义类型的大工程中，常常有必要给每种类型一个它自己的三个字符的前缀。如果这些前缀是以</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'>
"u" </span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:
"\000B ";mso-hansi-font-family:"\000B ";color:black'>开始的，那么当用一个用户定义类型来工作时，快速识别这些类型是很容易的。例如，</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'>ucli </span><span
style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>可以被用来作为一个用户定义的客户类型变量的前缀。</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'><br
style='mso-special-character:line-break'>
<![if !supportLineBreakNewLine]><br style='mso-special-character:line-break'>
<![endif]><o:p></o:p></span></p>
<h3 style='margin-top:6.0pt;margin-right:0cm;margin-bottom:6.0pt;margin-left:
0cm'><span lang=EN-US>5 </span><span style='font-family:
宋体;mso-ascii-font-family:"Times New Roman";mso-hansi-font-family:"Times New Roman"'>结构化编码约定</span></h3>
<p class=MsoNormal style='margin-top:6.0pt;margin-right:0cm;margin-bottom:6.0pt;
margin-left:0cm'><span lang=EN-US style='font-size:9.0pt;font-family:"\000B ";
color:black'><br>
<br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>除了命名约定外，结构化编码约定，可以极大地改善代码的可读性，如代码注释和一致性缩进。</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
<br>
<b>5.01 </b></span><b><span style='font-size:9.0pt;
font-family:宋体;mso-ascii-font-family:"\000B ";mso-hansi-font-family:"\000B ";
color:black'>代码注释约定</span></b><b><span lang=EN-US style='font-size:9.0pt;
font-family:"\000B ";color:black'><o:p></o:p></span></b></p>
<p class=MsoNormal style='margin-top:6.0pt;margin-right:0cm;margin-bottom:6.0pt;
margin-left:0cm'><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:
"\000B ";mso-hansi-font-family:"\000B ";color:black'>所有的过程和函数都应该以描述这段过程的功能的一段简明注释开始（这段例程干什么）。这种描述不应该包括执行过程细节（它是怎么做的），因为这常常是随时间而变的，而且这种描述会导致不必要的注释维护工作，甚至更糟—成为错误的注释。代码本身和必要的嵌入注释将描述实现方法。</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
<br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>当参数的功能不明显且当过程希望参数在一个特定的范围内时，也应描述传递给过程的参数。被过程改变的函数返回值和全局变量，特别是通过引用参数的那些，也必须在每个过程的起始处描述它们。</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
<br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>过程头注释块应该包括下列节标题。关于例子，请参阅下节“格式化代码”。</span><span
lang=EN-US style='font-size:9.0pt;font-family:"\000B ";color:black'><br>
<br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>节标题</span><span style='font-size:
9.0pt;font-family:"\000B ";color:black'> </span><span style='font-size:9.0pt;
font-family:宋体;mso-ascii-font-family:"\000B ";mso-hansi-font-family:"\000B ";
color:black'>注释描述</span><span lang=EN-US style='font-size:9.0pt;font-family:
"\000B ";color:black'> <br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>目的</span><span style='font-size:
9.0pt;font-family:"\000B ";color:black'> </span><span style='font-size:9.0pt;
font-family:宋体;mso-ascii-font-family:"\000B ";mso-hansi-font-family:"\000B ";
color:black'>该过程完成什么（而不是怎么完成）。</span><span lang=EN-US style='font-size:9.0pt;
font-family:"\000B ";color:black'> <br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>假设</span><span style='font-size:
9.0pt;font-family:"\000B ";color:black'> </span><span style='font-size:9.0pt;
font-family:宋体;mso-ascii-font-family:"\000B ";mso-hansi-font-family:"\000B ";
color:black'>列出每个外部变量、控件、打开文件或其它不明显元素。</span><span lang=EN-US style='font-size:
9.0pt;font-family:"\000B ";color:black'> <br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>效果</span><span style='font-size:
9.0pt;font-family:"\000B ";color:black'> </span><span style='font-size:9.0pt;
font-family:宋体;mso-ascii-font-family:"\000B ";mso-hansi-font-family:"\000B ";
color:black'>列出每个被影响的外部变量、控件、或文件及其作用（只有当它不明显时）。</span><span lang=EN-US
style='font-size:9.0pt;font-family:"\000B ";color:black'> <br>
</span><span style='font-size:9.0pt;font-family:宋体;mso-ascii-font-family:"\000B ";
mso-hansi-font-family:"\000B ";color:black'>输入</span><span style='font-size:
9.0pt;font-family:"\000B ";color:black'> </span><span style='font-size:9.0pt;
font-family:宋体;mso-ascii-font-family:"\000B ";mso-hansi-font-family:"\000B ";
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -