代码说明书Word文档格式.docx
- 文档编号:19616458
- 上传时间:2023-01-08
- 格式:DOCX
- 页数:11
- 大小:51.96KB
代码说明书Word文档格式.docx
《代码说明书Word文档格式.docx》由会员分享,可在线阅读,更多相关《代码说明书Word文档格式.docx(11页珍藏版)》请在冰豆网上搜索。
Else
Endif
Else
…
Endif
(4)为了防止在阅读代码时左右滚动代码编辑器,每行代码或注释不得超过一个显示屏。
(5)当一行分别为几行时,通过将串联运算符放在每行的末尾而不是开头,清楚地表示没有后面的行是不完整的。
(6)Case规则:
defaultcase总应该存在,如果不允许到达,则应该保证:
若到达了就会触发一个错误。
Case的选择条件最好使用int或string类型。
(7)对齐规则:
变数的申明和初始化都应对齐。
4.注释规范
4.1.块注释
//用户名非空验证+长度验证+合法性验证
functioncheckUserName(){
varname=document.myform1.txtUser;
if(name.value=="
"
){
alert("
请输入用户名"
);
name.focus();
returnfalse;
}elseif(name.value.length<
4||name.value.length>
16){//用户名长度验证
用户名输入的长度4-16个字符"
name.select();
4.2.行注释
用户名非空验证+长度验证+合法性验证
//用户名输入合法性验证
for(vari=0;
i<
name.value.length;
varcharTest=name.value.toLowerCase().charAt(i);
if((!
(charTest>
='
0'
&
&
charTest<
9'
))&
(!
a'
z'
(charTest!
_'
))
会员名包含非法字符,只能包括a-z、0-9和下划线"
returntrue;
//密码非空验证+确认验证+长度验证
functioncheckPass(){
varpass=document.myform1.txtPass;
varrpass=document.myform1.txtRPass;
if(pass.value=="
密码不能为空"
pass.focus();
}elseif(pass.value.length<
6||pass.value.length>
12){
密码长度为6-12个字符"
pass.select();
4.3.尾随注释
//获取用户名文本框中的值intm=4;
//获取密码框中的值
//用户名长度验证
4.4.注释哪些部分
项目
注释哪些部分
参数
参数用来做什么
任何约束或前提条件
字段/属性
字段描述
类
类的目的
已知的问题
类的开发/维护历史
接口
目的
它应如何被使用以及如何不被使用
局部变量
用处/目的
成员函数注释
成员函数做什么以及它为什么做这个
哪些参数必须传递给一个成员函数
成员函数返回什么
任何由某个成员函数抛出的异常
成员函数是如何改变对象的
包含任何修改代码的历史
如何在适当情况下调用成员函数的例子适用的前提条件和后置条件
成员函数内部注释
控制结构
代码做了些什么以及为什么这样做
难或复杂的代码
处理顺序
5.命名
5.1.命名的基本约定
(1)要使用可以准确说明变量/字段/类的完整的英文描述符,如firstName。
对一些作用显而易见的变量可以采用简单的命名,如在循环里的递增(减)变量就可以被命名为”i”。
(2)要尽量采用项目所涉及领域的术语。
(3)要采用大小写混合,提高名字的可读性。
为区分一个标识符中的多个单词,把标识符中的每个单词的首字母大写。
不采用下划线作分隔字符的写法。
有两种适合的书写方法,适应于不同类型的标识符:
PasalCasing:
标识符的第一个单词的字母大写;
camelCasing:
标识符的第一个单词的字母小写。
下表描述了不同类型标识符的大小写规则:
标识符
大小写
示例
命名空间
Pascal
namespaceCom.Techstar.ProductionCenter
类型
publicclassDevsList
publicinterfaceITableModel
方法
publicvoidUpdateData()
属性
PublicintLength{…}
事件
publiceventEventHandlerChanged;
私有字段
Camel
privatestringfieldName;
非私有字段
publicstringFieldName;
枚举值
FileMode{Append}
参数
publicvoidUpdateData(stringfieldName)
stringfieldName;
6.首页代码
<
SCRIPTtype="
text/javascript"
language="
javascript"
>
functioncheckForm(){
if(checkUserName()&
checkPass()&
checkEmail()&
checkDate()){
}else{
//确认密码一致性验证
if(rpass.value!
=pass.value){
确认密码与密码输入不一致"
rpass.select();
//电子邮件验证
functioncheckEmail(){
varstrEmail=document.myform1.txtEmail;
if(strEmail.value.length==0)
电子邮件不能为空!
strEmail.focus();
}elseif(strEmail.value.indexOf("
@"
0)==-1)
电子邮件格式不正确\n必须包含@符号!
strEmail.select();
."
0)==-1){
电子邮件格式不正确\n必须包含.符号!
}//@和.字符不能在句首
elseif(strEmail.value.charAt(0)=="
||strEmail.value.charAt(0)=="
符号@和符号.不能在邮件地址第一位"
}//@和.字符不能在句尾
elseif(strEmail.value.charAt(strEmail.value.length-1)=="
||strEmail.value.charAt(strEmail.value.length-1)=="
符号@和符号.不能在邮件地址最后一位"
7.用户登录代码
8.用户注册代码
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 代码 说明书