代码注释及易读性

最新推荐文章于 2023-07-21 23:12:25 发布
最新推荐文章于 2023-07-21 23:12:25 发布
阅读量674 收藏
点赞数
分类专栏： 工作簿 文章标签： string
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/TiramisuH/article/details/4583081
版权

最近发觉自己很菜

代码写的易读性比较差 就是命名啊什么的没有很规范

于是搜罗一些规范学习了一下

自我总结

 

代码注释不易过多,但是要能清楚的说明这段程序的含义功能等方面

命名要易懂 a开头的数组变量 str开头的string类型变量等等

 

总之，还是多实践多写从中总结经验啦

helen,fighting~~~

TiramisuH
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
提高代码可读性： 命名技术
04-15
为自己建立一致的命名风格，从此远离命名的困扰吧！ 
代码易读性探索总结
weixin_30770495的博客
06-28 214
写在前面:　　代码的易读性,个人认为是非常重要,受团队重视但是不能始终贯彻的.虽然面向对象已经成为了不二主流,在PHP的大世界里,在本人遇到的各种PHPer中,面向过程的写法仍比比皆是.维护成本也各不相同.　　下面是本人在工作中的一些总结和想法,如有看的不舒服的,换个舒服的姿势. 命名　　命名规范是编码的基本,下划线和驼峰只是形式,实质还是要看想要这个名字做什么. 　　1.确定使用动词性质还是...
漫谈代码可读性
宋宝华
04-12 817
我们不提倡以貌取人，但是人确实有美丑之别，美人让人赏心悦目，丑人让人。。。不那么赏心悦目。代码也一样。计算机编程里有一组相关的概念，一个叫做Prettify(美化)，一个叫做Uglify(...
IOS 将逻辑和视图分开 代码易读性和复用性大大增加
Kangl的博客
01-16 1047
记得之前看了一本书，[精通Objective-C设计模式].(Pro.Objective-C.Design.Patterns.for.iOS).Carlo.Chung.文字版.pdf 书中再次提到一定要把View层分开，阐述了View就是接受用户事件，绘制UI界面的地方。 这几天在写一个小游戏的时候，无意中在View层中加入了很多逻辑处理代码，代码的可读性简直糟糕。 于是再次想到了《
代码“可读性”到底有多重要？
HuiCMs的博客
10-16 3588
嵌入式处理器发展到今天，速度已经很可观了。而产品的快速迭代，要求技术积累和技术细分，代码可继承性，即“可读性”的要求会越来越高。 易读！易读！易读！！ 倘若对自己代码有要求，你会发现，它几乎是最重要的。神眼中的“优雅”，可能就蕴含在这里面。 关于如何写出可读性强的代码，有很多好书值得详细阅读，《C专家编程》、《代码大全》、《编程珠玑》，等等。这个课题很大，我只讲一些个人的心路历程： 代码1 uin...
PHP如何编写易读的代码
10-30
- 使用空行和缩进来增强代码的视觉层次感，使代码更易读。 - 避免过长的函数和方法，保持每个功能尽可能简洁。 - 使用适当的注释来分隔代码段，例如`// --- End of function ---`。 7. **命名约定**： - 遵循...
代码注释器
08-06
首先，代码注释器的主要任务是对源代码进行解析，提取其中的逻辑结构和关键信息，然后以更易读的形式呈现出来。对于初学者或不熟悉特定编程语言的人来说，这是一个非常实用的功能，因为它能够帮助他们快速理解复杂的...
java开发规范拥抱易读代码
03-03
遵循这些规约，能帮助开发者写出高质量、易读易维护的代码，提升团队协作效率，同时减少后期维护成本。切记，优秀的代码不是让人难以理解的代码，而是即使过了一段时间，自己仍能轻易理解其意图的代码。拥抱易读代码...
清理代码注释和空行
04-13
在编程过程中，代码注释和空行起着至关重要的作用，它们使得代码更易读、易维护。然而，在某些特定情况下，比如软件著作登记、版本控制或者代码优化时，可能需要清理或统一代码中的注释和空行。本文将详细讨论如何...
代码注释规范
11-29
- 使用清晰易读的英文，避免缩写和过于复杂的句子。 - 注释应简洁明了，避免冗余。 5. **注释风格** - **统一风格**：整个项目应保持一致的注释风格。 - **保持更新**：当代码修改后，相应的注释也应及时更新，...
代码整洁
出河种花的花田
04-09 498
关于代码整洁刚开始写代码没有去关心代码写得好不好看，而只是专注在功能的实现。后来随着代码量越来越多就出现了很多问题，当代码中发生错误时，自己面对自己写的代码却很头疼，请教别人帮忙时，别人看我的代码更是头疼。这让我慢慢意识到代码整洁的重要性，首先，整洁的代码易读性强，在查找错误的时候可以避免不必要的时间浪费，其次，在团体工作中，别人更容易理解你写的代码，可以提高大家的工作效率。 参考前辈的总结，要写出
C++编码风格指南(如何写出易读的代码)
yang1fei2的博客
06-27 370
编程跟说话一样，要想言简意赅逻辑清晰，就要学会掌握一定的规则和方法。只有掌握了对应的规则，才能写出优美的程序。这里通过代码留白、代码注释、标识符命名三个方面介绍，如何写出清晰明了的代码。 代码留白 林锐博士，在林锐·高质量C 编程指南之中特别指出了，通过代码留白写出结构松散的代码可以提高代码的易读性。 代码留白指恰当的运用空行分隔代码块，用空格分隔开变量和操作符，保持阅读的节奏。 下面介绍一下代码留白的策略，方便大家的使用，避免生搬硬套。 1.在每个类声明之后、每个函数定义结束之后都要加空行 2
编写易读代码的艺术——第一章 代码应该容易让人理解
ZhangIt的专栏
03-07 1292
代码应该容易让人理解 在过去的5年中，我们收集了许多“丑陋代码”的例子（其中大部分是我们自己写的），然后分析到底是什么使代码变丑陋，应用什么原则/技巧能把代码变好。最终我们注意到，所有的原则都源于一个主题： 代码应该容易让人理解。 我们相信这是你在写代码时你能用到的最重要的一条指导原则。通过这本书，我们将向你展示如何把这个原则应用到你日常编程的方方面面中。但在开始之前，我们先
C语言对常量的引入使程序易读性更好，且更容易维护
Paul_YQ的博客
02-24 211
#include<iostream> using namespace std; int main() { int score[5],max=0; //分别定义两个由逗号分隔的数组，整型变量 cout<<"请依次输入5个学生的成绩："<<endl; int i;//新添加一个循环计数变量 for(i=0;i<5;i++) ...
提高代码易读性之改善函数命名
一群专业码农的笔记本
10-08 559
命名是一门艺术
C——如何提高程序可读性
雨潇的博客
01-18 3615
程序的可读性高是一个程序员良好的编程习惯的体现。可读性高可以让程序员更好的理解冗长的代码，同时也更容易发现错误并且修改。不仅如此，在你请求别人对你的程序进行修改时，也能让别人更好的进行修改工作。否找面对一坨坨的代码段，恐怕没人愿意读下去吧。 所以这里就提供几个提高程序可读性的技巧，如果你觉得自己的代码太“丑”的话，不妨试试他们吧！ 1.选择有意义的函数名、变量名 比如你想定义一个标识符来...
注释分区
刘洪瑞的博客
09-28 178
//#region 注释的介绍 //这里是被注释的代码 //#endregion
代码质量与代码可读性：如何编写易于阅读和理解的代码
最新发布
禅与计算机程序设计艺术
07-21 2638
作者：禅与计算机程序设计艺术 一般来说，代码质量与代码可读性是相辅相成的关系。在编写代码时要考虑代码质量，保证代码可读性则是确保代码质量的前提。好的代码应该具备易于阅读、易于维护、容易扩展等特性，并且代码应具有高效率，功能实现正确且稳定，符合软件设计准则等特点。阅读过计算机相关书籍的人都知道代码的重要性。一个优秀的程序员除了有能力编写出高
算法--什么是算法
weixin_41828354的博客
11-03 406
什么是算法：数据结构+算法=程序 算法特性： 1、有穷性 2、确定性 3、可行性 4、输入输出：有0个或多个输入，一个或多个输出 好算法的标准： 1、正确性 2、易读性 3、健壮性：算法对非法数据及操作有较好的反映和处理 4、高效性：时间复杂度 5、低存储性：空间复杂度 算法复杂度计算方法 （1）空间复杂度： 1、输入输出数据 2、算法本身 3、额外辅助空间 （2）时间复杂度： 递归算法复杂度计算 递归：递推和回归 ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值