Delphi source program format writing specification
http://www.delphiforums.com/
Tianhaiyise (translation)
1. Normally introduction This specification mainly provides rules and precautions that the Delphi source program should follow during the writing process. The purpose of writing this specification is to keep the source code of the company software developers. Doing so allows each group of members to understand the code of other group members so that the maintenance of the secondary development memory system of the source code. 2. General Format Specification 2.1 Indenting Indentation is two spaces exposed by increasing readability when changing the level of the source program. The indented rules are indented to two spaces per level. Not allowed to use Tab. Because Tab will produce different results due to the settings made by the user. When you encounter Begin or enter judgment, cycle, abnormal processing, WITH statement, record type declaration, class declaration, etc., when you encounter END or exit judgment, loop, exception handling, WITH sentence, record type declaration, Time to decrease the level when the class declaration is equal. For example, if tmpint <> 100 THEN TMPINT: = 100; 2.2 Begin..endbegin statement and END statement to be exclusive in the source program, for example: for i: = 0 to 10 do begin // incorrect usage end; for I: = 0 to 10 do // The correct usage becomund; 2.3 Space adds a space on both ends of the operator and logic judgment symbol, for example: i: = i 1;, A and B, but do not need to add parentheses Space. For example: if (a> b) THEN // error Usage IF (a> b) The correct usage is, for example: Procedure Test (param1: integer; param3: string); 3. Object Pascal Syntax Writing format 3.1 Reserved Word Object Pascal language reserved words or keywords should be used to use lowercase letters. 3.2 Processes and Functions 3.2.1 Names and Format Processes and Functions The names of the function should be all consisting of meaningful words, and all the first letters of all words should use uppercase letters. For example: procedure formatharddisk; // incorrect naming procedure formatharddisk; // The correct naming setting variable content process and functions should be used as a prefix, for example: procedure setusername; read variable content processes and functions should be used As a prefix, for example, the parameter of the process and function is written in the same sentence. 2.2 Naming all parameters must be meaningful; and when the parameter name and other attribute name are heavy, add a prefix 'a', for example: procedure SomeProc (AUSERNAME: STRING; aUSERAGE: Integer); 3.2.2.3 Name conflict When using two Units, a renameful function or procedure is used, when you reference this function or process, the function or process in the Unit declared in the USE clause is executed. To avoid this 'Uses-Clause-Dependent' needs to write full functions or processes in the reference function or procedure. For example: sysutils.FindClose (SR); Windows.FindClose (Handle); 3.3 Variables 3.3.1 Variable Naming and Format First All variables must have meaningful names, so that other members can easily read the meaning representative of variables, Variable naming can use synonymous English name, you can use several English words, but the first letter of each word must be capitalized.
For example: Var WriteFormat :: string; at the same time for some specific types, certain simultaneous writies are used as follows: Pointer type P Record Type REC array type ARR class Class cycle control variable usually uses a single character such as i, j, or k. Also use a meaningful name, for example: UserIndex is also permitted. 3.3.2 Local variables Use local variables in the process to follow naming rules for all other variables. 3.3.3 Global variables Try not to use global variables, if you have to use global variables, you must add the 'g', and the type of variable should be embodied in the variable name. For example: gprecuserCount: Point; // Name is a global variable of UserCount, which is a pointer to a structure but can use global variables inside the module. The global variable in all modules must be prefixed with 'f'. If you need to exchange between several modules, you need to be implemented by a method of declaring properties. For example: type TFormOverdraftReturn = class (TForm) private {Private declarations} FuserName: string; FuserCount: Integer; Procedure SetUserName (Value: string); Function GetUserName: string; public {Public declarations} property UserName: string read GetUserName write SetUserName; property UserCount: Integer Read FuserCount Write FuserCount; End; 3.4 Type 3.4.1 Size Name of Size Protocol Reserved Words must be lowercase. The type of Win32 API is usually all written. For other types of first letters, the rest of the letter is lowercase, for example: var myString: string; // reserved Word windowHandle: hwnd; // Win32 API Type i: integer; // type ide Identifier IntroducesD in System Unit3.4.2 Floating point Types Do not use the REAL type, he is just compatible with the old Pascal code, try to use the Double type. The Double type is optimized to the processor and data bus and is the standard data structure defined by the IEEE. When the value exceeds the range of Double, use extended. But Extended is not supported by Jave. But use Single types when using other languages. 3.4.3 Enumeration Type Enumeration Type The name must be meaningful and the name of the name is prefixed before. The name of the enumeration type must contain a shorthand of the enumeration type name, for example: tsongtype = (Strock, StClassical, StCountry, Stalternative, Stheavymetal, StrB); 3.4.4 An array type array type must have meaningful and type name Before you have prefix 't'. If a pointer to an array type must be prefixed before the name of this type, the 'p', for example: type pcycleArray = ^ TcycleArray; tcycleArray = array [1..100] of integer; 3.4.5 Record Type Record Type The prefix 't' must be prefixed before and the type of name.
If a pointer to an array type must be prefixed before the name of the name, for example: type pemploye = ^ temployee; temployee = record Employeename: String Employeeerate: double; end; 3.5 class 3.5.1 Names and format classes The name must be meaningful and the name of the name is prefixed before. For example, the name of the Type TCUSTOMER = Class (TOBJECT) class is usually the name of the class of 't'. For example: VAR Customer: TCUSTOMER; 3.5.2 Variables in Class 3.5.2.1 Names and Formattes The names must be meaningful and the names are prefixed before. All variables must be four. If you need to access this variable from an external variable, you need to declare an attribute 3.5.3 method 3.5.3.1 Name and format name and format with functions and procedures. 3.5.3.2 Property Access Method All Properties Access Method must appear in the private or protected. The name of the attribute access method is named after the function and process of the process, and the prefix 'Get' must be used with the write method (Writer Method) must use the prefix 'SET'. The parameters of the write method must be named 'Value', which is consistent with the attribute you want. For example: TSomeClass = class (TObject) private FSomeField: Integer; protected function GetSomeField: Integer; procedure SetSomeField (Value: Integer); public property SomeField: Integer read GetSomeField write SetSomeField; end; 3.6 Properties 3.6.1 name and format of which was the same The name of the variable of the class of the class of the class of 'F' is operated. 3.7 File 3.7.1 Project Document 3.7.1.1 Project Directory Structure Program Oser Catalog - BIN (Path of the Application) -DB (the path where the local database) -DOC (the path where the document is located) -Backup (Backup Path) -tmp (Temporary File Path) 3.7.1.2 Name Project File must use a meaningful name. For example: project files for system information in Delphi are named sysinfo.dpr. 3.7.2 Form file 3.7.2.1 Name the name of the Form: For example: The name of the FormMain is formmain, the name of the FormMain.frm. 3.7.3 Data Module file 3.7.3.1 Naming Data Module files should make sense, and use 'DM' as a prefix. For example: User Data Module is named 'DMCUSTOMERS.DFM'. 3.7.4 Remote Data Module File 3.7.4.1 Naming Remote Data Module file should make sense, and use 'RDM' as a prefix. For example: User Remote Data Module is named 'RDMCUSTOMERS.DFM'. 3.7.5 Unit files 3.7.5.1 Ordinary Unit3.7.5.1.1 Unit file Name Unit files should make sense, and use 'unit' as a prefix. For example: General Unit is named 'UnitGeneral'.
3.7.5.2 Form Units3.7.5.2.1 Name the name of the form unit file must be consistent with the name of the Form. For example: The main form is called formmain.pas, the name of the Form Unit file is: UnitFormMain. 3.7.5.3 Data Module Units 3.7.5.3.1 Name The name of the Data Module Unit file must be consistent with the name of Data Module. For example: The main Data Module called Dmmain.pas The name of the Data Module Unit file is: UnitdmMain. 3.7.5.4 File Headers should write the purpose of this file on the head of all files, authors, date, and inputs and outputs. For example: {modified: OF: Purpose: This module structures:} 3.7.6 Forms and Data Modules Forms3.7.6.1 Form 1. Form class naming standards Forms class category name should be meaningful, and the use of 'TForm' as Prefix. For example, the name of the About Form class is: Taboutform = Class (TForm) The name of the main form is TMAINFORM = Class (TFORM) 2. The name of the name of the name of the standard form of the Form class instance is the name of the 't''s FORM class. The name is consistent. For example:. Type Name Instance Name TaboutForm AboutForm TmainForm MainForm TCustomerEntryForm CustomerEntryForm 3.7.6.2 Data Modules Form3.7.6.2.1 Data Module Form Naming Standard Data Modules Forms class should be meaningful, and the use of 'TDM' prefix. For example: TDMCUSTOMER = Class (TDATAMODULE) TDMORDERS = Class (TDataModule) 3.7.6.2.2. Data Module Instance Name Standard Data Module Form's class instance name should be the same as the name of the 't''s Data Module Form class. For example: Type Name Instance Name TCUSTOMERDATAMODERDATAMODMODATAMODERSDATAMODERDERDATAMODATAMODERSDATAMODERDERDERSDATAMODULE 3.8 Control 3.8.1 An instance of a naming control instance should use the name of the 't' that control class as a prefix, for example: Enter the name of the TEDIT of the user: editusername. 3.8.2 The name of the shorter control of the control can use the following shorthand, but the drug is added to the drug name between the drug is added to '_':
3.8.2.1 Standard Tabmm TMainMenupm TPopupMenummi TMainMenuItempmi TPopupMenuItemlbl TLabeledt TEditmem TMemobtn TButtoncb TCheckBoxrb TRadioButtonlb TListBoxcb TComboBoxscb TScrollBargb TGroupBoxrg TRadioGrouppnl TPanelcl TCommandList3.8.2.2 Additional Tabbbtn TBitBtnsb TSpeedButtonme TMaskEditsg TStringGriddg TDrawGridimg TImageshp TShapebvl TBevelsbx TScrollBoxclb TCheckListboxspl TSplitterstx TStaticTextcht TChart3.8.2.3 Win32 Tabtbc TTabControlpgc TPageControlil TImageListre TRichEdittbr TTrackBarprb TProgressBarud TUpDownhk THotKeyani TAnimatedtp TDateTimePickertv TTreeViewlv TListViewhdr THeaderControlstb TStatusBartlb TToolBarclb TCoolBar3.8.2.4 System Tabtm TTimerpb TPaintBoxmp TMediaPlayerolec TOleContainerddcc TDDEClientConvddci TDDEClientItemddsc TDDEServerConvddsi TDDEServerItem3.8.2.5 Internet Tabcsk TClientSocketssk TServerSocketwbd TWebDispatcherpp TPageProducertp TQueryTableProducerdstp TDataSetTableProducernmdt TNMDayTimenec TNMEchonf TNMFingernftp TNMFtpnhttp TNMHttpn Msg TNMMsgnmsg TNMMSGServnntp TNMNNTPnpop TNMPop3nuup TNMUUProcessorsmtp TNMSMTPnst TNMStrmnsts TNMStrmServntm TNMTimenudp TNMUdppsk TPowerSockngs TNMGeneralServerhtml THtmlurl TNMUrlsml TSimpleMail3.8.2.6 Data Access Tabds TDataSourcetbl TTableqry TQuerysp TStoredProcdb TDataBasessn TSessionbm TBatchMoveusql TUpdateSQL3.8.2.7 Data Controls Tabdbg TDBGriddbn TDBNavigatordbt TDBTextdbe TDBEditdbm TDBMemodbi TDBImagedblb TDBListBoxdbcb TDBComboBoxdbch TDBCheckBoxdbrg TDBRadioGroupdbll TDBLookupListBoxdblc TDBLookupComboBoxdbre TDBRichEditdbcg TDBCtrlGriddbch TDBChart3.8.2.8 Decision Cube Tabdcb TDecisionCubedcq TDecisionQuerydcs TDecisionSourcedcp TDecisionPivotdcg TDecisionGriddcgr TDecisionGraph3.8.2.9 QReport Tabqr TQuickReportqrsd TQRSubD
