📄 noahweb开发者月刊-第四期（开发命名规范）.htm
字号:
z;。 </LI></UL></UL>
<P class=style5>代码注释规范</P>
<BLOCKQUOTE>
<P><SPAN class=style5> </SPAN><SPAN
class=style1><SPAN lang=EN-US
style="FONT-FAMILY: 宋体">.cs文件的注释<O:P></O:P><BR></SPAN></SPAN><SPAN
class=style1><SPAN lang=EN-US
style="FONT-FAMILY: 宋体"><O:P> <SPAN><SPAN
style="mso-bookmark: _Toc59264529"><SPAN
style="FONT-FAMILY: 宋体">所有<SPAN
lang=EN-US>.cs文件开头都要加上注释，写明文件创建时间、作者、用途概述等<O:P></O:P><BR><SPAN
class=style5> </SPAN><STRONG>例如：</STRONG>
</O:P></SPAN></SPAN></P>
<P
class=MsoNormal>//********************************************************<O:P></O:P></P>
<P
class=MsoNormal>//新增日期:2004.7.19<O:P></O:P></P>
<P class=MsoNormal>//作者:XXX <O:P></O:P></P>
<P class=MsoNormal
style="MARGIN: 0cm 0cm 0pt 40.05pt; mso-para-margin-left: 3.64gd">//內容说明: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX<O:P></O:P></P>
<P
class=MsoNormal>//********************************************************<O:P></O:P></P>
<P><SPAN class=style5> </SPAN><SPAN
class=style1><SPAN lang=EN-US
style="FONT-FAMILY: 宋体">函数过程注释<SPAN
lang=EN-US><O:P></O:P><O:P></O:P><BR></SPAN></SPAN><SPAN
class=style1><SPAN lang=EN-US
style="FONT-FAMILY: 宋体"><O:P> <SPAN><SPAN
style="mso-bookmark: _Toc59264529"><SPAN
style="FONT-FAMILY: 宋体">所有的函数体开头都要加上注释，所以注释使用<SPAN
lang=EN-US>.NET注释规范。<BR><SPAN
class=style5> </SPAN><STRONG>例如：</STRONG>
</O:P></SPAN></SPAN></P>
<BLOCKQUOTE>
<P class=MsoNormal align=left>///
<summary><O:P></O:P></P>
<P class=MsoNormal align=left>///
构造函数<O:P></O:P></P>
<P class=MsoNormal align=left>///
</summary><O:P></O:P></P>
<P class=MsoNormal align=left>/// <param
name='is_xxx1'>示例参数1</param><O:P></O:P></P>
<P class=MsoNormal align=left>/// <param
name='is_xxx2'>示例参数2</param><O:P></O:P></P>
<P class=MsoNormal align=left>public
UpgradeThread(string is_xxx1, string
is_xxx2)<O:P></O:P></P>
<P class=MsoNormal align=left>{<O:P></O:P></P>
<P class=MsoNormal
align=left>//…<O:P></O:P><BR>}<O:P></O:P></P></BLOCKQUOTE>
<P><SPAN class=style5> </SPAN><SPAN
class=style1><SPAN lang=EN-US
style="FONT-FAMILY: 宋体">常量变量注释<SPAN
lang=EN-US><O:P></O:P><BR></SPAN></SPAN><SPAN
class=style1><SPAN lang=EN-US
style="FONT-FAMILY: 宋体"><O:P> <SPAN><SPAN
style="mso-bookmark: _Toc59264529"><SPAN
style="FONT-FAMILY: 宋体">所有的常量变量，无论是全局还是局部使用的，凡是对代码整体起到关键性做用的都需要加上注释。</SPAN></SPAN></SPAN></SPAN></SPAN><BR><SPAN
class=style5> </SPAN><STRONG>例如：</STRONG>
</O:P></SPAN></SPAN></P>
<BLOCKQUOTE>
<P class=MsoNormal align=left>///
<summary><O:P></O:P></P>
<P class=MsoNormal align=left>///
当前线程指向的备份文件本地保存路径<O:P></O:P></P>
<P class=MsoNormal align=left>///
</summary><O:P></O:P></P>
<P class=MsoNormal align=left>public string
StorePath = '';<O:P></O:P></P></BLOCKQUOTE>
<P><SPAN class=style5> </SPAN><SPAN
class=style1><SPAN lang=EN-US
style="FONT-FAMILY: 宋体"><SPAN>代码修改注释<SPAN
lang=EN-US><O:P></O:P><SPAN
lang=EN-US><O:P></O:P><BR></SPAN></SPAN><SPAN
class=style1><SPAN lang=EN-US
style="FONT-FAMILY: 宋体"><O:P> <SPAN><SPAN
style="mso-bookmark: _Toc59264529"><SPAN
style="FONT-FAMILY: 宋体"><SPAN><SPAN
style="mso-bookmark: _Toc59264529"><SPAN
style="FONT-FAMILY: 宋体">当开发者维护以前的程序代码时，需要在修改处的开始及结尾，加上自己的注释信息</SPAN></SPAN></SPAN></SPAN></SPAN>。</SPAN></SPAN></SPAN></SPAN></SPAN><BR><SPAN
class=style5> </SPAN><STRONG>例如：</STRONG>
</O:P></SPAN></SPAN></P>
<BLOCKQUOTE>
<P class=MsoNormal align=left>//BEGIN 2004-7-19
Jayson 修正了XXX问题<O:P></O:P><BR>略…<O:P></O:P><BR>//END
2004-7-19 Jayson<O:P></O:P></P></BLOCKQUOTE>
<BLOCKQUOTE>
<P class=MsoNormal
align=left> </P><O:P></O:P></BLOCKQUOTE></BLOCKQUOTE>
<P align=right><A
href="http://www.blueidea.com/articleimg/magazine/noahweb/4/#top">返回导航</A> </P></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></SPAN></TD></TR></TBODY></TABLE></TD></TR></TBODY></TABLE><BR>
<TABLE class=logicbiaoge221 cellSpacing=10 cellPadding=2
width="80%" border=0>
<TBODY>
<TR>
<TD width="100%">
<TABLE class=style1 height=150 cellSpacing=0
cellPadding=10 width="100%" border=0>
<TBODY>
<TR>
<TD>
<P align=center><STRONG><SPAN class=style3><A
name=PHP></A>PHP中的命名规则</SPAN></STRONG><FONT
size=2><STRONG> </STRONG></FONT></P>
<P align=left><FONT class=style1
id=zoom><STRONG><SPAN
class=style6>类的命名</SPAN></STRONG></FONT></P>
<BLOCKQUOTE>
<P align=left><FONT class=style1><STRONG>
</STRONG>在为类（class
）命名前首先要知道它是什么。如果通过类名的提供的线索，还是想不起这个类是什么的话，那么就说明设计存在问题。</FONT><FONT
size=2><BR></FONT> <FONT class=style1
id=zoom>超过三个词组成的混合名是容易造成系统各个实体间的混淆，尝试使用（CRC Se-
ssion card)看看该命名所对应的实体是否有着那么多的功用。</FONT><FONT
size=2>
<BR></FONT> 对于派生类的命名应该避免带其父类名的诱惑，一个类的名字只与它自身有关，和它的父类叫什么无关。<BR> 使用大写字母作为词的分隔，其他的字母均使用小写，名字的首字母使用大写
。不要使用下划线('_') 。<BR> <STRONG>例如：</STRONG> <FONT
class=style1 id=zoom>class NameOneTwo<BR>
class Name</FONT></P></BLOCKQUOTE>
<P><STRONG><SPAN
class=style6>类库的命名</SPAN></STRONG></P>
<BLOCKQUOTE>
<P><STRONG> </STRONG>目前命名空间正在越来越广泛的被采用，以避免不同厂商和团体类库间的类名冲突。当尚未采用命名空间的时候，为了避免类名冲突，一般的做法是在类名前加上独特的前缀，两个字符就可以了，当然多用一些会更好。<BR> <STRONG>例如：</STRONG>
John Johnson的数据结构类库可以用Jj做为前缀，如下：<BR><FONT
class=style1 id=zoom> </FONT>class
JjLinkList <BR><FONT class=style1 id=zoom>
</FONT>{ <BR><FONT class=style1 id=zoom>
</FONT>} </P></BLOCKQUOTE>
<P><FONT class=style1 id=zoom><STRONG><SPAN
class=style6>方法的命名</SPAN></STRONG></FONT></P>
<BLOCKQUOTE>
<P><FONT class=style1><STRONG>
</STRONG>采用与类命名一致的规则，同样是使用英文单词诠释出方法的作用。<STRONG> <BR> 例如：</STRONG>class
NameOneTwo <BR> { <BR> function DoIt()
{}; <BR> function HandleError() {};
<BR> } </FONT></P></BLOCKQUOTE>
<P><FONT class=style1 id=zoom><STRONG><SPAN
class=style6>类属性的命名</SPAN> </STRONG></FONT></P>
<BLOCKQUOTE>
<P><FONT class=style1><STRONG>
</STRONG>属性命名应该以字符‘m’为前缀。前缀‘m’后采用于类命名一致的规则。‘m’总是在名字的开头起修饰作用，就像以‘r’开头表示引用一样。
<BR> 前缀'm'防止类属性和方法名发生任何冲突。你的方法名和属性名经常会很类似，特别是存取元素。<STRONG> <BR> 例如：</STRONG>class
NameOneTwo <BR> { <BR> function
VarAbc() {}; <BR> function ErrorNumber()
{}; <BR> var mVarAbc; <BR> var
mErrorNumber; <BR> var mrName; <BR> }
</FONT></P></BLOCKQUOTE>
<P><FONT class=style1 id=zoom><STRONG><SPAN
class=style6>方法中参数的命名</SPAN></STRONG></FONT></P>
<BLOCKQUOTE>
<P><FONT class=style1><STRONG>
</STRONG>第一个字符使用小写字母。在首字符后的所有字都按照类命名规则首字符大写。<STRONG> <BR> </STRONG>这样做可以随时知道哪个变量对应哪个变量。另外，这样做可以使用与类名相似的名称而不至于产生重名冲突。<STRONG><BR> 例如：</STRONG>class
NameOneTwo <BR> { <BR> function
StartYourEngines( <BR> &$rSomeEngine,
<BR> &$rAnotherEngine); <BR> }
</FONT></P></BLOCKQUOTE>
<P><FONT class=style1 id=zoom><STRONG><SPAN
class=style6>变量的命名</SPAN></STRONG></FONT></P>
<BLOCKQUOTE>
<P><FONT class=style1><STRONG>
</STRONG>所有字母都使用小写。使用'_'作为每个词的分界<BR> 通过这一途径，代码中变量的作用域是清晰的。所有的变量在代码中都看起来不同，容易辨认。<STRONG> <BR> 例如：</STRONG>function
HandleError($errorNumber) <BR> {
<BR> $error = OsErr();
<BR> $time_of_error =
OsErr->getTimeOfError;
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -