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

Best practices in function definition

There are proven best practices for function and method definition provided by amazing software engineering resources, such as Clean Code: A Handbook of Agile Software Craftsmanship, by Robert C. Martin, Code Complete: A Practical Handbook of Software Construction, Second Edition, by Steve McConnell, and Coding Horror (https://blog.codinghorror.com/code-smells/), that we can summarize as follows:

  • Try not to exceed 8-10 lines of code in each function as shorter functions or methods are easier to read, understand, and maintain.
  • Keep the number of parameters minimal because the more parameters a function has, the more complex it is.
  • Functions should have at least one parameter and at least one return value.
  • Avoid using type names in function names since they are going to be redundant.
  • Aim for one and only one functionality in a function.
  • Name a function or method in a way that it describes its functionality properly and is easy to understand.
  • Name functions and methods consistently. For instance, if we have a connect function, we can have a disconnect one.
  • Write functions to solve the current problem and generalize it when needed. Try to avoid what-if scenarios as probably You Aren't Going to Need It (YAGNI).

It is important to follow these best practices. After all, we are talking about FP and you know, functions are important!

主站蜘蛛池模板: 施秉县| 常州市| 汾西县| 静乐县| 呼玛县| 通辽市| 河东区| 偏关县| 尼玛县| 田阳县| 新郑市| 丰镇市| 宁南县| 盐城市| 阿拉尔市| 建昌县| 胶南市| 台东市| 新兴县| 梨树县| 衡东县| 广平县| 天津市| 界首市| 应城市| 衡阳县| 康马县| 桦甸市| 常州市| 公安县| 马龙县| 丰原市| 黔西| 柳河县| 兴城市| 顺义区| 娱乐| 天镇县| 清水河县| 南昌县| 林芝县|