Web programmer coding specification (ASP)

Developer on Alibaba Coud: Build your first app with APIs, SDKs, and tutorials on the Alibaba Cloud. Read more ＞

I. Page Design
1. IMG Control
ALT: all display images must have a text description that briefly describes the image content.
2. input control
Maxlength: Specifies the maxlength attribute for all input controls. The default value is the length of the corresponding field in the database.
Readonly: The readonly attribute must be used for all unchangeable information.
3. Form Control
Action: action must be specified for all forms. If submitted to itself, Action = "" is specified ""
Method: Use post to perform irreversible actions, and use get to perform reversible actions.
Onsubmit: All forms must specify the check programs required before submission.
All forms must have corresponding reset buttons.
4. Button Control
Onclick: the button used for submission in form does not allow this method. All data checks are activated through form's onsubmit.
5. Title attributes
All pages must have the same title as this page.
6. Control naming
Use the control type abbreviation (lower case) + English word (the first letter in upper case.
Controls in Development basically involve several types
Button: BTN
Form: FRM
Select: Sel
Textarea: txt
Input: IPT
7. Language settings
Add the following statement to all Chinese pages:

8. Control attribute assignment
The attribute values of all controls must be enclosed in double quotation marks or single quotation marks.

Ii. Client Program
1. Handling of error message (2-1)
All error messages are displayed in Chinese. punctuation marks are used as follows:
"Error:" + prompt message + "! "
2. Processing of successful prompts (2-2)
All successful messages are displayed in Chinese. punctuation marks are in the following format:
"Success:" + prompt message + "! "
3. Page return
Use history. Back () when returning the previous page; do not use history. Go (-1 );
Use history. Go (-N) when you need to return the first n pages (n> 1 );
All responses are connected instead of buttons.
4. Data judgment before submission
Make sure that the data before submission is determined by the Javascript data type and length.
Digit or not: Use the isnan () function ()
Length determination: determine the actual length after removing Spaces
Empty: All input fields that are not allowed to be empty must be judged after spaces are removed. If this field is a query condition, it must not be blank.
If a data error is found in the judgment condition, the system prompts the error message through (2-1), and then focuses the error field through the method focus.
5. Prompt before data deletion
All operations involving deletion must be confirmed after the user is selected.

Iii. server-side programs
1. Data Acquisition
The data transmitted through the get and post connections must be removed through trim before and after the data is used.
2. Data judgment
The parameter data obtained through the request must be determined again by null, type, and length.
3. Close the object
All Database and file objects should be closed as early as possible after use, and nothing should be assigned at the same time.
4. Prompt information
All error messages are prompted using JavaScript to ensure that the user does not see any internal error messages. (For example, 1-1)
A prompt is required for successful operations involving database update, Del, and insert. (For example, 1-2)
5. Use of Variables
All variables must be declared before use, and the initial value is assigned.
6. variable naming
The variable type abbreviation (lower case) + English word (the first letter in upper case) is used.
Variables in development basically involve several types
Integer: I
Decimal: F
Character: S
Boolean: B
Date: d
Special:
I, j, m, n are used in sequence in the cycle;
Array with ary
Pointer p, q
Temporary Variable TMP

VII. SQL statements
1. Sort
When order is used, try to sort the fields that create indexes or primary keys in advance.
2. Select
Avoid using * When selecting. Even if all fields are required, list them one by one in the order they are used.
3. Avoid using in and not in whenever possible

8. Test
All pages must run at 800*600,102 4*768 resolution.
All pages must run in ie5.0, 5.5, and 6.0 without JavaScript errors.

**************************************** ************************

Web coding Specification
Prepared by: walaqi

Chapter 1 ASP coding specifications
ASP encoding consists of two parts: static file encoding and dynamic file encoding containing server scripts.
Static file encoding consists of script encoding and HTML encoding.
Server-side encoding is divided into three parts: server script, client script, and HTML Script.
The encoding rules adopt the following conventions:
All client scripts use JavaScript
All server scripts use VBscript
HTML scripts are used for static page output.
This specification does not apply to client script code generated by server scripts.

Chapter 2 static file encoding specifications:
The static file script is written in JavaScript. The output part adopts the HTML markup language.
1. html markup language coding Specification
1.1 line feed specification for marking:
* A tag must occupy one row. Do not mark two rows with the same mark (except for the mark with the same mark), for example:

Text

It must be written as follows:
Text

1.2 mark closing rules
* The static file content must be included in the tag.
* The tag must be included in the tag.
* For tags to be closed, such:
　　

<SELECT> <option> the flag must appear at the same time as the flag. For example, ... ........... ..... * do not contain cross-contained statements, such as: ..... 1.3 attribute assignment specification for tags that accept attributes, the attribute values must be enclosed by double quotation marks or single quotation marks. For example: 1.4 indentation specification * top-level parent tags are written in the left-aligned top lattice mode. * The Next Level mark is written in the left-aligned and right-indented form of a tab. the next level is as follows, * the first character of the same level mark must be aligned up and down. 2. client JavaScript specification 2.1 variable naming convention * constants and global variable names must all use uppercase letters * the first letter of the variable name must be lowercase. * The variable name must start with a string of its type. Various types of written strings are as follows: * integer variable: int * long integer variable: LNG * floating point variable: flt * double-precision variable: DBL * object reference variable: OBJ * string variable: Str * date type variable: DTM * variable names must be named with meaningful words, such as: strusername, lngarrayindex * variable names, except lowercase letters, other words must start with uppercase letters * If the variable name is too long, you can use the abbreviations, except for the widely known abbreviations, all variable names written using words must be annotated during definition, for example: var stradname // indicates the name of the Administrator account var stradminname // without comments, admin is widely known 2.2 variable usage rules * variables must be defined before use. Undefined variables cannot be used * The use of variables should be minimized to a small scope. For example, use for (VAR I = 0; I } instead of: var I; for (I = 0; I } 2.3 object naming conventions The following prefixes must be used when naming various page objects, such as text input boxes, buttons, and drop-down selection boxes.: * text input box: TXT * button: BTN * select drop-down box: sel * option: opt * Form: FRM * frame: FRA * hidden form item: HDN * Div Tag: div * span flag: Span * dialog box object: DLG * window object: win 2.4 naming conventions for functions and sub-procedures * function names must be used Verb + noun pair method, and can reflect the function functions * the verb prefix of the function name must be a complete verb related to the function * the first letter of the function name is lowercase, uppercase letters of each word Chapter 3 dynamic file encoding specifications 1. HTML writing specifications HTML writing specifications must comply with HTML marking writing specifications for static files. For details, see section 1 of chapter 2. 2. client script specification dynamic file client scripts are all written in JavaScript and must comply with the JavaScript code specification in static file encoding specifications (refer to Section 2 of Chapter 2) 3. server-side script writing specifications server-side script writing adopts VBScript writing 3.1 naming conventions 3.1.1 VBScript variable naming conventions * constants and the global variables must all use uppercase letters * constants are required. You must use the const _ prefix * The global variable must use the G _ prefix * the first letter of the variable name must be in lowercase. * The variable name must start with a string of its type. Various types of written strings are as follows: * integer variable: int * long integer variable: LNG * floating point variable: flt * double-precision variable: DBL * object reference variable: OBJ * string variable: Str * date type variable: DTM * variable names must be named with meaningful words, such as: strusername, lngarrayindex * variable names, except lowercase letters, other words must start with uppercase letters * If the variable name is too long, you can use the abbreviations, except for the widely known abbreviations, all variable names written using words must be annotated during definition, for example, dim stradname 'indicates the name of the Administrator account dim stradminname' does not need to be annotated, admin is widely known 3.1. 2 object naming conventions various objects such as connection, recordset, and command must use the following prefix during naming: * connection object: conn * recordset object: RS * command object: CMD * parameter object: Param * Field object: operator * error object: Err 3.1.3 function and sub-process naming rules * function naming must use a verb + noun pair, and can reflect the function * the verb prefix of the function name must be a complete verb related to the function * the first letter of the first word in the function name is capitalized, 3.1.4 naming rules for common variables: Description: The parts included in [] are omitted. * connection Object: conn [name]. Name is the name of the server connected to the database * recordset variable naming convention: Rs [name]. Name is a custom combination of English words related to the RS storage content * command object: cmd [name]. Name is a custom combination of English words related to command purposes * SQL statement string variable: strsql [commandname]. Commandname is a custom combination of English words related to the SQL statement function. For example: strsqlupdatemodify strsqlinsertuser 3.2 code writing specifications 3.2.1 explicit declaration principles of variables * All ASP program files, must be included in the first line of the Code. Convert to variable explicit declaration mode 3.2.2 Character Set setting principles * All ASP program files that generate Chinese output to the client, charset must be set to "gb2312" before output ". for example: response. charset = "gb2312" 3.2.3 function usage principles * use function encapsulation code blocks as much as possible * do not exceed 50 consecutive code blocks. Up to 70 rows * use local variables whenever possible. * if global resources, such as connection, are involved, try to pass in as a function parameter * all resources created and opened in the function, you must disable release before exiting the function. For example, recordset, command 3.2.4 request, session, and application usage specifications * all objects to be put into the session and application must use meaningful English names. Except for the widely used word abbreviations, you cannot use them. For example, SESSION ("CP") = strcurrentuserip' is not allowed SESSION ("currentuserip") = strcurrentuserip SESSION ("PWD ") = strpwd 'Allow, PWD is widely known as a password * all elements in the request, session, and application that need to be used in the code, variables declared in the Code must be assigned to the Code header. * if you get the content submitted in form, you must use request. form ("itemname "). * if you get the content submitted in querystring, you must use request. querystring ("itemname") * the request ("") cannot appear in the code. this reference method 3.2.5 principles of hybrid use of HTML and server-side scripts * server-side script mark " <Table> do while not Rs. EOF %> <tr> <TD> text </TD> </tr> rs. movenext loop %> </table> * the server script mark "*" %> "is the same as its the preceding Code cannot be written in the same line * server scripts Mark "%>" with its latest "* the HTML code inside the server is written according to the HTML indent rules of static files, does not follow the server-side script indent rules * HTML marks internal code, according to the server-side script indent rules, do not follow HTML code indent rules Chapter 4 Common Errors 1. ado transaction processing error code 1.1: 80004005. 1.1.1 error description: Microsoft ole db provider for ODBC drivers error '000000' transaction cannot be started in firehose mode 1.1.2 solution: when starting an ADO transaction, you must first close the record set opened with the same connection object, or before opening those cursor sets, set the cursor set location type to aduseclient. (use client cursor set) Chapter 5 examples of code habits 1. ADO object usage 1.1 ADODB. connection object 1.2 ADODB. command object 1.3 ADODB. recordset object 1.3.1 created: set rs = server. createobject ("adod B. recordset ") Rs. cursorlocation = aduseclient Rs. open strsql, Conn, 1 [, 1] 'must specify the cursor type 1. annotation specification . annotation standard: L function annotation function annotation refers to the annotation to explain the Code itself. the annotator uses "'" as the unified annotator. 1. intra-row comments use the comment symbol "'" example: dim intfileno as integer "cannot be used to obtain the call number 2. whole Line (including multiple rows) comment block start and block end signs 36 '************** * ******************* ' '********************************** L revision comments revision comments indicate the purpose of testing or correction, the Code has been changed, but the modification must be described and highlighted, and the original code must be added to the comment block. if there is any change, the modification part of the logo is clearly explained by setting the comment block start and block end signs for both single and multiple lines, it is easy to find and distinguish the code segments with more comments. 15 '***************** modify start ********* * ***** ' '*********** * *** end **************** B. description: Declaration definition comments each constant declaration. comments the declaration of each variable, class, object, and so on; annotate each custom function definition. annotate each custom subroutine definition. Code annotate each component, comment on the top. comment on the branch selected for each condition. comment on the key points mentioned in each detailed design; comment out the use of global variables. C. comments: L comments to the variable and constant declaration section are in-line comments. Describe its purpose. note at the top of the definition section of L user-defined functions and subroutines: '*********************************** * 'summary: 'function Description: 'parameter description: 'Return value: ' remarks: '*********************************** * L intra-row comments in the Code describe the operation rules of the specific code, loop content, counter purpose, and so on. L revision comments '***************** modify start ******** * ****** 'reasons for revision: 'revision history: 'Revised by date 'original code: 'case 5 to 8 '...... case 4 to 8 '**************** end *********** * *** D. annotation method: you can add comments to the end of a line (the line width cannot be violated ); you can add a simple comment on a single line of code in the form of "'" in the previous line. place the comment on the entire code segment before the code segment; the annotator uses "'". II. Naming Conventions A. General principles the Reserved Words in Visual Basic can be viewed in the Visual Basic designer based on color changes. Variable naming cannot use reserved words. Meaningful names should be used. Abbreviation and meaningless names such as A and X1 cannot be used. Even for variables that are only used for cyclic counting, they should be uniformly assigned with meaningful names, such as longcnt. the name cannot be too long and should be as concise as possible. The length limit should be within 32 characters. B. constants all use uppercase letters to indicate the names of nouns indicating the meaning of constants. The type of constants is not distinguished: const defaultconcentration as single = 0.01 C. variable names must be case-sensitive (VB Editor automatically converts to reduce the chance of program errors) variable naming adopts [range prefix] [array prefix] [type prefix] + [custom name] Control naming adopts [control prefix] + [custom naming] variable range prefix range prefix example global variable g gstrusername module-level M mstrusername no strusername at the process level array Prefix: A type Prefix: data type prefix example Boolean bln blnfound Te BYT bytrasterdate currency cur curbalance date DTM dtmbegindate double DBL dbl1_ integer int intqty long LNG lngvcid single Sng sngaverage string STR stritemid Object OBJ objrmtsvr ADODB. recordset rst rstitem ADODB. connection CNN cnnnewspaper ADODB. command CMM cmaddcustomer variant vnt vntcheck Custom type UDT udtuserinfo control type naming prefix example of control type prefix ADO data ADO adobiblio check box chk chkreadonly combo box, drop-down list box CBO cboenglish command button cmd cmdexit Common Dialog DLG dlgfileopen data-bound combo box dbcbo dbcbolanguage data- bound grid dbgrd dbgrdqueryresult data-bound list box dblst dblstjobtype data combo dbcauthor Data Grid DG D dgdtitles data list DBL dblpublisher directory list box dir dirsource drive list box DRV drvtarget file list box fil filsource form frm frmentry frame FRA fralanguage graph gra grarevenue grid GRD grdprices horizontal scroll bar HSB hsbvolume image img imgicon image combo imgcbo imgcboproduct imagelist ILS ilsallicons Label LBL lblhelpmessage line Lin linvertical list box lst lstpolicycodes listview LVW lvwheadings menu MNU mnufileopen month view mvw mvwperiod MS chart ch chsalesbyregion MS flex grid MSG msgclients MS tab MST mstfirst Option Button opt optgender picture box PIC picvga progressbar PRG prgloadfile Remote Data RD rdtitles Slider SLD sldscale spin spnpages statusbar sta stadatetime sysinfo sys sysmonitor tabstrip tab taboptions text box txt txtlastname timer TMR tmralarm toolbar TLB tlbactions Treeview tre treorganization updown UPD upddirection vertical scroll bar VSB vsbrate Develop the prefix of ActiveX control by yourself according to the design rules of the specific project. D. Tag the tag is the code ID used for the Goto jump. Because the Goto is not recommended, the tag is also demanding. All labels must be in uppercase, and the spaces in the middle must be replaced by underscores (_). They must begin with underscores (_). For example: _ a_label_example: tags are defined to be fully different from other code elements. E. Method both functions and subprograms must be named by a verb or verb phrase. No need to distinguish between functions and subprograms, or specify the return type. sub open (byval strcommandstring as string) function setcopynumber (byval intcopynumber as integer) as integer you must specify the byval or byref parameter, this will increase the length of the program, but it is necessary. If not, use byval. For the parameter naming method, refer to "variable naming method ". 3. Writing format specifications . program writing sequence Brief description of the component variable declaration Process Declaration code segment 1 code segment 2 ...... B. case the prefix of the variable name range must be in lower case, the first letter of each word is capitalized. functions, procedures, and object names must also be capitalized at the beginning of each word. C. indent unify the development environment, set the development environment option of the Visual Basic designer, and define the tab width to 4. When the code is indented, first select the code block to be indented, and then use the shortcut keys tab (right shift) and SHIFT + tab (left shift). If you manually enter a space to indent, the Unit is 4 spaces. indent after the if statement; indent after the else statement indent after the select case statement indent after the DO statement indent after a for statement each row of a statement that has been separated by a row connection character must be indented indent after a with statement. indent the Code marked from the row. D. space the operator must contain spaces, including: +,-, *,/, ^, =,>,> =, not, And, or; E. empty rows the variable declaration part and the code statement are separated. An empty row is inserted between each statement group that executes the Unified Task. Good code should be composed of processes or related statement groups in a logical order. F. page width for long statements, such as API declarations, wrap lines within the visible range of the code form. Do not make it possible for others to view the complete code through a rolling window, the code length of a single row cannot exceed 95 columns. use the "& _" line break. G. Others in the project team, the parameters of the Visual Basic development environment are unified as needed. 4. Code check code check criteria complete comments, naming conventions, clear and readable codes are considered as qualified codes.. check method failure to comply with the code specification is deemed as unqualified; 5. coding standards L sometimes, good programming principles may be violated, or some informal methods may be used. In this case, you must describe in detail what you are doing and why you want to do so. for highly skillful code segments, you must add detailed comments instead of letting other developers spend a long time researching a highly skillful but hard-to-understand program segment. L indent the comment to align it with the subsequent statement. comments are usually located at the beginning of the Code to be explained. To visually highlight the relationship between the annotation and its code, indent the annotation, make it at the same level as the Code 6. ambiguity arising from the understanding of other documents is explained by the project owner of the project that references this document. posted on wddavid read (...) comment (...) edit favorites refresh comments and refresh the page. Return to the top. blog homepage: Ask the news flash programmer recruitment knowledge base. <! -- Done --> copyright 2013 wddavid powered by: the blog garden template provides: hujiang blog </option> </SELECT>

This article is an English version of an article which is originally in the Chinese language on aliyun.com and is provided for information purposes only. This website makes no representation or warranty of any kind, either expressed or implied, as to the accuracy, completeness ownership or reliability of the article or any translations thereof. If you have any concerns or complaints relating to the article, please send an email, providing a detailed description of the concern or complaint, to info-contact@alibabacloud.com. A staff member will contact you within 5 working days. Once verified, infringing content will be removed immediately.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

Get Started for Free

Sales Support

1 on 1 presale consultation

Chat Contact Sales
After-Sales Support

24/7 Technical Support 6 Free Tickets per Quarter Faster Response

Open a Ticket
Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.

Learn More

Web programmer coding specification (ASP)

Contact Us

What's Trending

Top 10 Tags

Top 10 Keywords

A Free Trial That Lets You Build Big!

Sales Support

After-Sales Support

Web programmer coding specification (ASP)

Contact Us

What's Trending

Top 10 Tags

Top 10 Keywords

Trending Topic

A Free Trial That Lets You Build Big!

Sales Support

After-Sales Support