php代码的健壮性,AngularJS 公共方法代码健壮性思考

深碍√TFBOYSˉ_ 2023-01-16 11:08 167阅读 0赞

公共方法

当我们写一些公共组件或方法时，我们可能需要接收外部的参数，但是，我们并不总能保证我们的注释是完全能让他人理解的。

/\*\*

\* 获取所有考评员信息

\* @param \{district\} 区域

\* @param \{department\} 部门

\* @param \{discipline\} 学科

\*/

self.getAllExaminerInfoByDistrictAndDepartmentAndDiscipline = function(district, department, discipline) \{

// 设置请求参数

var params = \{

districtId: district.id,

departmentId: department.id,

disciplineId: discipline.id

\};

// 请求后台接口，返回

return $http.get(baseUrl, \{ params: params \});

\};

错误使用

就像上面的这段代码，属于在Service中的公共方法，乍一看，可能看不出什么错误，我们注释写得好好的，我要个什么什么对象，用的时候传给我就好了。

编码常有失误，如果他人不小心传了个undefined进来。

var params = \{

districtId: district.id,

departmentId: department.id,

disciplineId: discipline.id

\};

然后我们这段代码就是从undefined中获取属性，就会抛出错误。

当然，以软件工程师的骄傲，他不是先考虑自己哪里写错了，而是认为你这个公共的方法有问题，然后找写这个方法的人进行激烈地讨论，浪费了半个小时发现原来是参数传错了。这严重地影响了开发的效率。

参数校验

所以我们的公共方法既要写注释，让人能看懂，也要对每一个传入的参数表示“怀疑”。

公共方法，可能会有很多人使用，为了减少参数传错造成的时间浪费，所以我们需要在我们的逻辑真正地执行之前，对传入的参数进行校验。

我们可以对这几个传入的区域、部门、学科对象进行校验。

if (!district) \{

throw '未接收到区域信息';

\}

这样，如果我们没有传该参数或传入一个undefined，我们的控制台就会报错，提示开发者“未接收到区域信息”。

![bVbboez?w=137&h=24][bVbboez_w_137_h_24]

这样，开发者就能准确而快速地定位错误，自己这个方法用错了，并且根据提示，是自己的区域信息传错了，这就减少了互相争论与讲解的成本。

公共方法随手throw一条提示信息，节约程序员debug的万千时间。

[bVbboez_w_137_h_24]: https://segmentfault.com/img/bVbboez?w=137&h=24

发表评论取消回复

表情：

评论列表（有 0 条评论，167人围观）

还没有评论，来说两句吧...

相关阅读

相关如何使用Java的异常处理，提高代码健壮性？

在Java中，异常处理是一种重要的机制，用于处理程序运行时可能出现的错误情况，从而提高代码的健壮性。以下是一些使用Java异常处理来提高代码健壮性的方法： 1. **理解异常

Love The Way You Lie/ 2024年11月01日 04:09/ 0 赞/ 49 阅读

相关通过异常处理，提升Java代码健壮性

在Java编程中，异常处理是一种机制，用于处理程序运行时可能出现的错误情况。以下是如何通过异常处理提升Java代码健壮性的几个步骤： 1. **捕获异常**：使用`try-c

ゞ浴缸里的玫瑰/ 2024年10月23日 16:09/ 0 赞/ 50 阅读

相关使用Java进行异常处理，提高代码健壮性

在Java中，异常处理是通过try-catch-finally结构实现的。以下是一个简单的例子来解释如何使用异常处理： ```java public class Except

「爱情、让人受尽委屈。」/ 2024年10月15日 20:33/ 0 赞/ 54 阅读

相关 C++异常处理：提高代码健壮性和可维护性

目录 C++异常处理：提高代码健壮性和可维护性 1. 异常处理机制抛出异常捕获异常异常安全性 2. 异常处理的最佳实践选择合适的异常类型捕获异常的层次

矫情吗；*/ 2024年02月17日 13:11/ 0 赞/ 85 阅读

相关 php代码的健壮性,AngularJS 公共方法代码健壮性思考

公共方法当我们写一些公共组件或方法时，我们可能需要接收外部的参数，但是，我们并不总能保证我们的注释是完全能让他人理解的。 /\\ \ 获取所有考评员信息 \ @par

深碍√TFBOYSˉ_/ 2023年01月16日 11:08/ 0 赞/ 168 阅读

相关干货！java代码性能优化，提高健壮性

本文转载自：[https://juejin.im/post/6844904036114645000][https_juejin.im_post_6844904036114645

以你之姓@/ 2022年11月25日 10:25/ 0 赞/ 325 阅读

相关使用python3的typing模块提高代码健壮性

typing模块的作用：类型检查，防止运行时出现参数和返回值类型不符合。作为开发文档附加说明，方便使用者调用时传入和返回参数类型。该模块加入后并不会影

偏执的太偏执、/ 2022年10月10日 06:05/ 0 赞/ 180 阅读

相关【Python教程】typing模块的作用-提高代码健壮性

typing模块的作用：类型检查，防止运行时出现参数和返回值类型不符合。作为开发文档附加说明，方便使用者调用时传入和返回参数类型。该模块加入后并不会影

ゝ一纸荒年。/ 2022年09月13日 15:24/ 0 赞/ 216 阅读

相关软件设计目标—健壮性

import java.io.; public class CommandLineCalculator { private int accumul

深藏阁楼爱情的钟/ 2022年06月15日 03:11/ 0 赞/ 203 阅读

相关关于Java健壮性的一些思考与实践

本文转载自：[https://mp.weixin.qq.com/s/NNJx4V\_DVEWBSFZNcnQdSA][https_mp.weixin.qq.com_s_NNJx

客官°小女子只卖身不卖艺/ 2021年07月09日 04:12/ 0 赞/ 392 阅读