写代码过程中需要注意的地方

最新推荐文章于 2024-08-01 16:42:03 发布
原创 最新推荐文章于 2024-08-01 16:42:03 发布 · 1.3k 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文介绍了软件开发过程中日志记录与参数校验的重要性。对于日志记录，建议采用带级别的日志框架，并避免输出敏感信息。参数校验方面，推荐在公开方法前增加有效性检查，防止因参数错误引发的异常。

1.使用日志框架打印日志：

需要注意的点：输出有级别区分的日志

                        输出带有有效信息的日志
                        日志中带上上下文信息。
                        不要在日志中输出用户的敏感信息。
                        不要在日志中输出像用户密码、邮件内容之类的涉及用户隐私的敏感信息，也不要去输出像验证码的值之类的敏感信息。

2.参数校验：（在友盟错误统计中，一些异常是由于参数没有加为空或者一些条件判断导致的错误）

在对外公开的方法前先插入一些检查参数的代码，以确保方法被 “正确的姿势” 调用


什么时候需要进行参数校验(具体做到什么程度，还需要根据情况去把握)：

    方法或者函数是对外公开的，不是私有的。

    参数有可能为空指针的时候。

    参数的合理值无法通过方法名、参数名、参数类型一眼看出来的时候！

不同的企业会有不同的编码规范，以下是世界上最大的互联网公司谷歌的编码规范

Google Java Style Guide

Google C++ Style Guide

Google Python Style Guide

Google HTML/CSS Style Guide

Google JavaScript Style Guide
项目中写代码的注意事项总结
陌上花开缓缓归以的博客
04-24 1354
1，c++中怎么使用c语言中声明的函数，c语言中使用c++中声明的函数； 2，函数返回值一般用于返回错误码，不要用于直接返回函数的执行结果。 3，有符号和无符号数据类型的混合运算，应注意类型转换； 4，不要把子程序的参数用作工作变量，如果需要，另设一个临时变量来处理； 5，项目中禁止直接使用全局变量，一般用set/get函数来实现对全局变量的读写； 6，防止字符串拷贝时，存储空间不够，应保证有NULL结束符，既是在获取拷贝字符串时，应该意识到存储空间的大小，宁可截断，也不要越界。 7，函数返回值
【C++软件调试技术】C++软件开发维护过程中典型软件异常问题的排查与总结
热门推荐
dvlinker的技术专栏
04-15 17万+
本文以问答的方式进行展开，罗列了C++软件日常开发和维护中遇到的多个软件调试问题及有代表性的场景，给出详细的处置思路和处理办法，以供大家借鉴和参考。
初级程序员写代码应该注意的问题
黄富贵
08-03 626
初级程序员写代码应该注意的问题
写代码需要注意的地方
songqiang2011的博客
06-10 1072
以下属于个人总结，如有更好的方法或错误欢迎评论指出。 一、命名：一个好的命名让代码的可读性更强。（希望大家评论给出自己更好的命名方法，我再更新到这） 1）类名需要尽可能的简约（不超过三个业务描述的单词，超过了可以缩写某个单词或直接省略）；例如 用户控制类 UserController，用户日志控制类 UserLogController，登录用户新增日志控制类 LoginAddLogController（这里省略了用户单词） 2）方法名可以描述更具体特别是带查询条件方法；例如 通过名称，班级id查询用户
写代码时要注意的点
Chersresting
11-02 204
接口在哪里，实现在哪里，不要让没有接口的类去实现逻辑，这是完全无关的 设计之前最好和leader说明一下，让他看下这个设计有哪些不太符合规范的地方 事件名字和事件触发的方法名尽量有些关系，不要做特化，因为可能以后还有其他方法也要监听该事件 加热事件+=加热； 然后加热方法里面调用方法1 而不是 加热事件+=方法1； 因为这种方法如果以后加热事件要触发方法2； 就要又写一句+=； 而且别人如果想知道加热事件触发后调用了哪些方法 就要一个个去找+=，因为+=不一定放会在一起 但是第一种办法别人只要
写代码时应该注意的问题
知行天下
05-04 1686
1, 代码可维护性相关  (1), svn 提交不写注释  (2), 命名太随意  (3), 代码随意排版  (4), 多层嵌套结构  (5), 一个方法包打天下 ： 要记住 -- 单一职责原则, 一个方法不应该承载太多，要尽量抽取出来。  (6), 不统一的风格  (7), 混乱的 pom 文件  (8), 晕头转向的配置文件 -- Spring配置文件, MyBatis map
IDEA 2020代码提示忽略大小写的问题
08-18
在编程过程中，代码提示功能是开发工具中的一个重要组成部分，它能极大地提高开发效率。IntelliJ IDEA，作为一款广受欢迎的Java集成开发环境（IDE），提供了丰富的代码提示和补全功能。然而，有时用户可能遇到IDEA在...
注意力机制及代码详解
qq_45528961的博客
03-05 2961
之后对平均池化和最大池化的结果，利用共享的全连接层进行处理，我们会对处理后的两个结果进行相加，然后取一个sigmoid，此时我们获得了输入特征层每一个通道的权值（0-1之间）。之后将这两个结果进行一个堆叠，利用一次通道数为1的卷积调整通道数，然后取一个sigmoid，此时我们获得了输入特征层每一个特征点的权值（0-1之间）。CBAM将通道注意力机制和空间注意力机制进行另一个结合，CBMA会对输入进来的特征层分别进行通道注意力机制的处理和空间注意力机制的处理。其重点是获得输入进来的特征层，每一个通道的权值。
php代码架构的八点注意事项
12-18
写代码写了6年多了，看看以前的架构，看看现在的架构。都有一些不足的地方。不管怎么样，都一直在改进。说实话不太喜欢用框架这类东西，基本上所有的框架都大同小异，差不了多少，要用话的，你还要去了解思想，目录...
GPT-Pilot —— 让AI来写代码
q345911572的博客
08-01 1538
GPT Pilot：一个AI开发者伴侣，可以从0开始构建应用程序，可以自己编写代码、配置开发环境、管理开发任务、调试代码。
编写代码过程中，注意事项
weixin_34007886的博客
09-22 190
如果写的是一个工具类的话，比如说想获取默认12个月，然后返回值希望是个map，那么这里的map做泛型定义的时候，就需要细化。写成Map<String, String>，而不能写成Map<String, Object>. 转载于:https://blog.51cto.com/503431920/1696970...
写代码注意点（自己总结）
weixin_30772261的博客
05-03 148
1、减少冗余代码（若有冗余代码，需要提炼出新的函数，进行调用）（面向对象编程中封装概念） 转载于:https://www.cnblogs.com/pingchangren/p/8985345.html
写代码注意事项
qq_52477177的博客
06-19 174
6、这个异常没有必要往上抛，不影响主流程，不会影响后续代码逻辑，只需要记录下来，吞掉，代码继续往下走。2、service入参做参数校验(@Valided)，controller层也要参数校验。5、异常==>看异常的子类。最好输出异常的参数，异常的信息，使用log.error（e）,4、调用同事的方法/service，要在日志中，调用前打印我们的入参，调用后打印出参。3、调用某个方法得到一个对象或者集合等等，要先optional判空。1、调用三方接口要做异常处理。
代码编写中的注意事项
Anger_Coder的专栏
05-17 1403
本人，有幸就
写代码中需要注意的事项！（停更 有些表达很不准确懒得改了）
Myrcella的博客
05-07 2724
1. 数组不越界、下标不能取负数（特别注意取%时进行加减运算时可能产生的数组越界问题）（循环是也容易出现问题） 2.n<=2*10^9都可以放心使用int的 3.dp时间复杂度在无优化的情况下通常为O（n^2），因此应根据情况合理使用搜索 4.数组开到10^9会爆掉。因此可以使用map进行代替。没有赋值（？）的map初始值为0 5.（尤其是图论题）带空格的输入一定用get，且第一行若...
写代码需要注意的几方面
weixin_30429201的博客
08-03 144
简洁性 尽量把公共部分都抽象成公共方法或工具类 可测试性 打印出变量值或经过了哪些流程步骤，方便定位 灵活使用插件 如自动生成代码的插件等，减少苦力 文档记录 包括注释等，使得思路清晰 可读性 转载于:https://www.cnblogs.com/cashew/p/11294701.html...
写代码时注意点（持续更新篇）
菜鸟的打怪升级之路
06-19 638
未完待续。。。。还会持续加入新的内容
代码编写时的规范和注意事项
m0_71417856的博客
04-20 1237
干净的代码既简单又直接。干净的代码读起来像写得很好的散文。简洁的代码永远不会掩盖设计者的意图，而是充满清晰的抽象和直接的控制线。—罗伯特·马丁（Robert C. Martin）
《代码整洁之道》-- 写代码时需要注意的命名技巧
RapdoZoroの博客
11-29 1761
最近在看《代码整洁之道》这本书，感觉这本书不错，其主体思想就是代码质量与其整洁度成正比。而具体如何量化代码的整洁度正是书中所讲。学习之余，整理了一下书中内容和作者思想，在此记下一些笔记并加上一些自己的理解和看法，希望通过记下这些加深学习和理解，更方便自己日后温故知新，同时分享给希望改善或提高自己编码质量的朋友们 这篇文章是对书中关于写代码时需要注意到的各种命名技巧进行总结，如下： 1.
去掉代码中的加密过程
最新发布
06-11
### 移除代码中的加密实现或步骤 在软件开发中，移除代码中的加密实现通常需要仔细分析现有代码结构和逻辑。以下是关于如何从代码中移除加密过程或删除加密相关逻辑的详细说明。 #### 1. 分析现有加密实现 首先，需要明确当前代码中使用的加密方法及其具体实现方式。根据提供的引用内容[^2]，加密文件的操作可能通过自定义函数 `decrypt_open` 实现。该函数负责打开加密文件并返回解密后的文件指针。如果要移除加密逻辑，可以考虑将此函数替换为普通的文件打开操作，例如使用标准库中的 `open` 函数。 ```python # 原始加密实现 def decrypt_open(file_path, key): # 解密逻辑 decrypted_content = decrypt_file(file_path, key) return decrypted_content # 替换为普通文件打开操作 def plain_open(file_path): with open(file_path, 'r') as f: return f.read() ``` #### 2. 替换加密函数 在代码中搜索所有调用加密函数（如 `decrypt_open`）的地方，并将其替换为普通文件操作函数。确保替换后不会影响程序的其他功能。 #### 3. 删除加密相关的依赖库 如果项目中引入了特定的加密库（如 PyArmor[^4] 或其他加密工具），并且不再需要这些库的功能，可以安全地移除对这些库的依赖。需要注意的是，移除依赖库前应确保没有其他模块依赖于这些库。 #### 4. 修改用户界面提示 根据引用[^1]，用户界面可能会包含与密码输入、密码强度等相关的提示信息。如果移除了加密逻辑，则需要同步更新或删除这些提示信息，以避免误导用户。 #### 5. 测试兼容性 在完成上述修改后，进行全面的测试以确保代码的功能未受影响。特别是需要关注不同浏览器对 Cookie 的处理差异[^5]，以及文件读取操作是否正常工作。 #### 6. 注意事项 - 如果代码中存在调试模式下的加密输出[^3]，需要一并移除这些调试逻辑。 - 确保移除加密逻辑后，代码的安全性仍然满足需求。例如，删除加密逻辑可能导致敏感数据暴露，因此需谨慎评估风险。 ```python # 示例：移除加密逻辑后的文件读取 def read_file(file_path): try: with open(file_path, 'r') as f: return f.read() except FileNotFoundError: return "File not found" ``` ###
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

zz白龙

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值