官术网_书友最值得收藏!

Succinct and proper documentation

You should always try to write self-documenting code. This can be achieved through good programming style. Write code in such a manner that your classes, methods, and other objects are self-documenting. A new developer should be able to pick your code and not have to be stressed out before understanding what the code does and its internal structure.

Coding elements should be descriptive and meaningful to provide an insight to the reader. In situations where you have to document a method or class to provide further clarity, adopt the Keep It Simple Short (KISS) approach, briefly stating the reasons for a certain decision. Check the following code snippet; nobody wants to have to read two pages of documentation for a class containing 200 lines of code:

///
/// This class uses SHA1 algorithm for encryption with randomly generated salt for uniqueness
///
public class AESEncryptor
{
//Code goes here
}

KISS also known as Keep it Simple, Stupid, is a design principle that states that most systems work at their best when they are kept simple rather than making them unnecessarily complex. The principle aims at aiding programmers to keep the code simple as much as possible, to ensure that code can be easily maintained in the future.

主站蜘蛛池模板: 清丰县| 保山市| 阿克陶县| 湖北省| 辽源市| 罗源县| 墨玉县| 高碑店市| 简阳市| 上杭县| 漾濞| 咸宁市| 娱乐| 南汇区| 榕江县| 安义县| 洛南县| 阜平县| 盐城市| 合川市| 湘阴县| 高台县| 奇台县| 宝山区| 新安县| 新田县| 宾阳县| 锦屏县| 甘肃省| 江川县| 防城港市| 平乐县| 铅山县| 凌源市| 关岭| 大厂| 陆川县| 陇西县| 楚雄市| 偃师市| 河西区|