Norm | Development Specification | Development Specification 1 Database Usage specification
1.1 All operations on the database on the server can only be performed by server administrators.
1.2 Access to a database in a program using a unified user, unified Connection file.
1.3 In principle, each channel can only build a library, the library name and the English name of each channel is consistent, the library contains a number of tables. Relatively large, focus on the column can be considered to build a separate library, the library name and the English name of the column is consistent.
1.4 Name:
(1) Database, tables, fields, indexes, views, and so on a series of database-related names must be named after the content-related English words (try to avoid the use of Hanyu Pinyin), for a word difficult to express, you can consider using multiple words underlined (_) connection (not more than four words) named.
(2) All names must be in uniform using the English lowercase letters.
(3) All names start and end with an underscore (_).
(4) All names cannot contain 26 characters other than English lowercase letters and underscores (_).
1.5 databases, tables that are no longer in use should be deleted and must be backed up (including structure and content) before they are deleted.
2 Documentation Specification
All projects must have relevant documentation (can be electronic documents). The document should contain the following contents:
(1) Project name.
(2) List of project team, project leader.
(3) Project development start time and end time.
(4) Description of the project content.
(5) Project location. (on which channel, which column)
(6) Project-related program file name (including path name), file content and implementation of the functional description.
(7) Complete program flow chart.
(8) Database, table, view, index name, purpose. The name, type, length, and purpose of the field must be accompanied by an associated SQL statement.
3 Source code and page nesting specification
3.1 Source code:
(1) You must declare variables before using custom variables (including global variables, local variables), and use comment statements to indicate the type and purpose of the variable.
(2) A custom function must use an annotation statement to indicate the purpose of the function, the data type of the parameter, the meaning, and the type of the return value.
(3) An important process in a program or a lengthy process should use an annotation statement to indicate the starting and ending lines of the process and to indicate the function of the process.
(5) All the annotation text is used in Simplified Chinese.
3.2 HTML page nesting:
(1) The HTML page designed by the web design department determines the position, width, number of rows (or height) to be used to dynamically display the results of the program execution in a <table></table> nested manner, and gives a textual description in the corresponding position. The complete URL must be used for pictures, text, joins, etc. that are not related to the program in the page.
(2) Software developers and editors can be consulted according to the situation, the page files and pictures and programs stored separately on their respective servers, the page revision and modify the program independently.
(3) The use of include technology will be divided into HTML pages embedded in the program code, required to modify the HTML page without rewriting the program, and modify the program will not affect the effect of HTML pages, the page revision and modification of the program two separate work.
(4) page and program nesting can not destroy the original HTML page overall display effect, font, font size, color, etc. should try to keep the original HTML page style.
(5) Dynamically generated pages of the various indicators (such as picture size, page width, height, page file number of bytes, etc.) should meet the requirements of the company's web design.
4 Test specification (software section)
For the larger project should set up a corresponding Test team, the team members by the software developers, web designers, technicians, editors and staff composition. The test process should refer to the original HTML page provided by the Web Design department for the project. The test content includes the following points:
(1) page width, height (number of rows).
(2) page text, pictures, colors are unified style.
(3) The picture of the page shows whether it is normal or not.
(4) The effect of the pop-up page.
(5) Whether the page is joined correctly.
(6) Whether the dynamically generated pages meet the requirements of the above several aspects, page size (number of bytes, including the picture of the page, *.js, *.css, *.class and other related documents) is consistent with the requirements of web design.
(7) Whether the software function is realized. such as database query, modify, delete, file upload, download and other operations are normal.
(8) After the test, according to the "Software development Requirements" in the "Test report" truthfully fill out the test results, including the test passed, failed, pointed out the error of the page and related program files, and the error message in the test.
