Project Development and Coding Standards
The integrated development environment offers ready-made objects that can perform many operations without the need to write code. Thanks to these objects, the user who will make the development can realize the process and form designs needed without the need to write code. The development environment also gives developers the option to write their code so that developers who want to perform more customized controls and processes can execute the scenarios they have designed.
When there are multiple developers using the development environment, or when the existing project developer changes, each project within the organization may be in different formats and complex structures that are impossible to understand and interpret unless a specific project development and coding standard is available in the system. In order to develop all the projects in the organization in a determined format, some standards to be complied with in the projects created in the development environment will be mentioned under this heading.
Meaningful Giving Solution and Project Names
The information about what type of projects a solution created in the Integrated Development Environment contains or what project a project is should be understandable with the nomenclature given. Thus, when another developer wants to review the projects, or when the person who developed the project tries to find a project that he has developed after the intervening time, he will not waste time opening individual projects and trying to understand what project it is.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Meaningful Giving of External Link and Query Names
External link names created in the development interface and query names created for use in processes should be meaningful. The information about which external link is made with which external source or what data the query returns should be understood by the given nomenclature. Thus, when the same connection and query is wanted to be used in another object or project, it will not cause loss of time to be understood.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Paying Attention to Code Indents and Alignments
In the code written in the Development Interface code editor screens, special blocks such as methods, if-else, try-catch and the indentations between value definitions should be considered. This will result in more readable and understandable code blocks.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Space Usage
When defining multiple variables, using a space after a comma between variable names, using a space between variables and operators in block statements, using a space after a comma between function parameters will make your codes more readable and included with a certain rule.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Uses of Block Annotation
Block comments are used at the beginning of code such as functions, modules, or projects to enter comments that may be required for later use. Descriptions should be written in such a way that they include what the relevant code block does and other necessary information, without going into too much detail. If any changes are made to the block, the description field must be updated. Comment blocks are crucial to the comprehensibility of the code.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
One-line comments
Single-line comments should be written at the beginning of the code blocks where certain operations take place, describing the code block at the bottom.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Using Inline Annotation
Inline descriptions should only be used in a way that describes the expression on the line in which it is located and expresses only the information of that line.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Capitalization Rules in Nomenclature
When naming elements such as properties and variables, the first letters of the word are named so that the first letters are small and the other letters are capitalized. In class and method names, the first letter is capitalized.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Both the uppercase version and the lowercase version of the same definition should not be used.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Turkish Character Usage
Turkish characters should not be used in the code because Turkish characters may be perceived differently in the code and cause errors.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Use of "Return"
When returning a value in functions, a variable can be used to return from a single place, or more than one return statement can be used where the value to be returned occurs. Depending on the code of the function written in which it will be returned, the use of variables and return from a single place should be preferred in complex code structures. If the written function value is to be returned in the switch-case structure, the value must be returned from the "case".
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Use of "if-else" structure
It is among the most used code blocks. In general, the line after the end of the condition line should be marked with the "{" sign and the block should be closed with the "}" sign after the coding in the condition is finished.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Conditions that require complex comparisons should not be written in the "if" block, but each condition should be assigned to a variable and the variables should be compared in the "if" block.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Comparisons with a data type of "bool" are directly compared. "==" or "!=" checks do not need to be reworked.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Checking the inverse of the condition unnecessarily in condition constructs should not be done because it increases code complexity and creates unnecessary lines of code.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Instead of using nested if blocks, else if structure should be preferred.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Using the "For – Foreach" Structure
In these two loop types, block brackets are necessarily used even if there is only one line of code in the loop. In addition, the variable should not be defined unless it is necessary in the loop.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Use of the "While – do/while" structure
The loop output is controlled by the loop out statement. It is not recommended to exit with if control in the loop unless it is necessary.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>
Use of the "Try – Catch" Structure
An empty catch block should never be defined in this structure. The catch block should not be used to control the flow or catch an exception that cannot be evaluated. No other try-catch block is used within the catch block. Exceptional case catch should be ranked from most likely to least likely to be caught.
:::d anger MISUSE
<div style={{textAlign: 'center'}}>
</div>
:::
CORRECT USAGE
<div style={{textAlign: 'center'}}>
</div>