Coding Standard
There are certain benefits from having a coding standard. If every programmer follows one agreed coding standard, including indentation, capitalisation, names and so on, it can improve programming speed and help the programmers communicate with each other. They also can focus on the real issues rather than focus on reformatting others' code to make it understandable.
What we've done.
There are mainly two ways, used to practice coding standard. The first one is that one agreed coding standard was made at the beginning of the project. To make the coding standard, well-known coding standards, namely Java and PHP coding standards, are examined. Thus everyone knows what to follow when they code and decide the variable names. It can also make one’s code easy to understand so when another person tried to modify other’s code, there was no problem caused by difference of each code. The second way is using code formatting function in Eclipse. At the beginning of the project, everyone import one agreed standard configuration file for Eclipse to one another’s Eclipse. Therefore, when any one had any problem with formatting, it could easily be solved by implementing code formatting function in Eclipse.
Any problems?
There are certain benefits from having a coding standard. If every programmer follows one agreed coding standard, including indentation, capitalisation, names and so on, it can improve programming speed and help the programmers communicate with each other. They also can focus on the real issues rather than focus on reformatting others' code to make it understandable.
What we've done.
There are mainly two ways, used to practice coding standard. The first one is that one agreed coding standard was made at the beginning of the project. To make the coding standard, well-known coding standards, namely Java and PHP coding standards, are examined. Thus everyone knows what to follow when they code and decide the variable names. It can also make one’s code easy to understand so when another person tried to modify other’s code, there was no problem caused by difference of each code. The second way is using code formatting function in Eclipse. At the beginning of the project, everyone import one agreed standard configuration file for Eclipse to one another’s Eclipse. Therefore, when any one had any problem with formatting, it could easily be solved by implementing code formatting function in Eclipse.
Any problems?
There was no serious issue with coding standard as one agreed standard was made at the beginning of project. The minor one is that every one needed time to get used to the coding standard. That small problem of getting used to the coding standard could be solved with checking the coding standard document, and more easily that was solved by using Eclipse code formatting function. If anyone was not sure whether he / she was following the right coding standard or not, only using code formatting function was required to ensure that the right coding standard is being followed.
No comments:
Post a Comment