Write the generate Industrial Standered Documentation in industrial_standered.php
if you done minor changes like add line and change spelinhg than update version number point "0" number increase by.
Example :-
v1.0.0 to v1.1.0
if you done medium changes like add more line , change paragraph , add design , add tag , add description and add some one column than update version number point "0" number increase by.
Example :-
v1.0.0 to v1.0.1
if you done major changes like add more line , change pages , add design , add description and add some one column than update version number point "0" number increase by.
Example :-
v1.0.0 to v2.0.0
| Name | Description | Example |
|---|---|---|
| Folder Name |
folder should br in small case and words should be seprated by underscore |
admin , employee_management , job_servoces , leaves , |
| File Name |
A folder should be created with the same name as the class camal case upper |
class AdminSecvice in your file name is AdminService.php |
| ViewFile Name |
View File and Business Logic File To keep all the letters small and to write 2 words while giving the name of the file, use square underscore |
addminemployee in your admin_employee.php |
| Class Name |
While writing the class name, capitalize the first letter of the first word and capitalize the first letter of the second word and this is called uper camal case. |
class AdminEmployee |
| (1) Global & Constant Variable |
the globle variable all letter should be uper case and write a underscore |
Upper case - EMPLOYEE_ADMIN = Global & Constant Variable |
| (2) local Variable |
the local variable all letter should be lower case |
Lower case - employee = local Variable |
| Database String Constants | Example Table | Example Column |
|---|---|---|
|
When writing database string constants, the table and column should also write shorted and upper case |
DatabaseStringConstants::$TBL_CAPTCHA = "captcha"; but database table in name are lower latter |
DatabaseStringConstants::$COL_CAPTCHA = "captcha"; but database table in name are lower latter |
| Tag Name | Assign Name | Example |
|---|---|---|
| img | img_givename | img_chat_icon |
| lable | lbl_givename | lbl_chat_icon |
| table | tbl_givename | tbl_chat_name |
| div | div_givename | div_chatbox_container |
| input type="text" | txt_name | txt_username |
| select | slt_name | slt_city |
| option | opt_name | opt_city |
| input type="textArea" | txtarea_name | txtarea_address |
| button | btn_name | btn_chat_icon |