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

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.

主站蜘蛛池模板: 新乡市| 前郭尔| 璧山县| 景谷| 汕头市| 大竹县| 宿松县| 桂阳县| 永丰县| 浮山县| 祁门县| 黄石市| 昌吉市| 宁德市| 双柏县| 灌南县| 宁明县| 且末县| 大同县| 浦城县| 汝阳县| 花垣县| 马关县| 灵武市| 澳门| 茶陵县| 绵阳市| 安达市| 历史| 怀化市| 武鸣县| 洞口县| 汤原县| 临海市| 济南市| 屯留县| 资兴市| 石林| 阜新市| 睢宁县| 阳曲县|