网站建设

网站建设

了解最新的网站建设动态、行业资讯和技术分享

网站制作中关于代码注释的7个技巧

2017-05-11 网站建设 3799 次阅读
1. 对齐注释行
对于那些在行末写有注释的代码,应该对齐注释行来使得方便阅读
有些开发人员使用tab来对齐注释,而另外一些人会用空格来对齐。由于tab在不同的编辑器和集成开发环境中会有所不同,所以最佳的方法是使用空格来对齐注释行。
2. 使用统一的风格
有些人觉得注释应该让非程序员也能看懂。另外一些人觉得注释需要面对的读者只是程序员。无论如何,正如Successful Strategies for Commenting Code中所说的,最重要的是注释的风格需要统一,并且总是面向相同的读者。就自己而论,我怀疑非程序员是否会去读代码,所以我觉得注释应该面向程序员来写。
3. 对不同级别的代码进行注释
对于不同级别的代码块,要使用统一的方法来进行注释。例如:
对于每一个类,需要包含一段简明扼要的描述,作者和上一次修改的时间
对于每一个方法,需要包含这个方法的用途,功能,参数以及返回结果
当你在一个团队里面的时候,采用一套注释的标准是非常重要的。当然,使用一种大家都认可的注释约定和工具(例如C#的XML注释和Java的Javadoc)在一定程度上能推动这项任务。
4. 使用段落注释
首先把代码块分解成多个“段落”,每一个段落都执行单一的任务;然后在每一个“段落”开始之前添加注释,告诉阅读代码的人接下来的这段代码是干什么用的
5. 不要侮辱阅读者的智慧
这不单把时间浪费在写没用的注释上面,同时也在分散读者的注意力。
6. 直截了当
不要在注释里面写过多的废话。避免在注释里面卖弄ASCII艺术,写笑话,作诗和过于冗长。简而言之就是保持注释的简单和直接。

相关新闻推荐

网站建设常见问题及解决方案:网站设计与用户体验

优秀的网站设计不仅能吸引用户,还能引导他们高效地完成目标操作,提升转化率。本文将分析网站设计与用户体验优化中的常见问题,并提供相应的解决方案。常见问题一:网站加载速度慢解决方案:优化图像:使用压缩工具减小图片文件大小,同时保持图像质量。利用:内容分发网络可以加速网站内容的全球分发。减少请求:合并、文件,减少页面加载时的请求次数。启用缓存:服务器和浏览器缓存可以减少重复加载相同资源的时间。常见问题二...

2025-02-13

网站建设常见问题及解决方案:域名选择与注册

在启动网站建设项目时,选择合适的域名是至关重要的一步。域名不仅是网站的地址,也是品牌在线身份的核心组成部分。本文将探讨域名选择与注册过程中常见的问题及解决方案。常见问题一:如何选择易于记忆且符合品牌形象的域名?解决方案:简洁明了:选择简短、直观、易于拼写的域名。关键词融入:如果可能,将品牌名称或业务关键词融入域名中,有助于和提升品牌识别度。避免数字和连字符:除非必要,否则尽量避免使用数字和连字符,...

2025-02-13

如何更好的选取网页标题?

1精准定位关键词:明确页面内容的核心关键词或短语。这些关键词应与页面的主题和内容紧密相关,能够准确反映页面的核心内容。避免使用过于宽泛的词汇,而应选择具体、精准的关键词,以提高搜索引擎的匹配度和用户的点击意愿。2简洁明了,突出重点:标题应该尽量简短,控制在一定字数范围内(一般建议不超过60个字),以避免被搜索引擎截断或用户在阅读时产生疲劳。突出页面的核心卖点或独特之处,使用有吸引力的词汇和句式,让...

2025-01-06

中小企业做网站的好处有那些?

在当今竞争激烈的市场中,中小企业是不可或缺的一部分。而随着互联网的发展,越来越多的企业开始认识到,建立一个良好的网站对企业的重要性。下面将详细介绍中小企业建立网站的优势。提升企业形象在当今互联网时代,网站已经成为企业的门面。企业通过设计精美的网站,可以提升企业形象,让客户对企业有更好的印象。一家好的网站设计,不仅能够给人留下深刻的印象,还能让客户感觉到企业的专业性和专注度。这样的形象可以吸引更多客...

2023-07-11

关于HSTS安全协议的全面详细解析

严格传输安全()是一种安全功能,服务器通过它来告诉浏览器仅用来与之通讯,而不是使用。是网站从到中网站性能及安全优化非常重要的一个步骤,能够解决和兼容中的一些不足之处。在全站下有一个较大的正向作用,推荐使用。一、是什么?国际互联网工程组织正在推行一种新的安全协议()。采用协议的网站将保证浏览器始终连接到该网站的加密版本,不需要用户手动在地址栏中输入加密地址。该协议将帮助网站采用全局加密,用户看到的就...

2023-04-27

建一个企业官方网站建设需要多少钱?

经常会有一些朋友问到:做个网站多少钱?网站建设要多少钱?建立一个网站是怎么收费的?。。。等等诸如此类的问题,今天跟朋友们分享,做一个网站至少需要多少钱的成本。首先我们要了解网站的组成部分:域名,服务器,网站设计与程序开发;一、域名成本:啥是域名?域名就是我们经常看到的网址。百度的网址:;淘宝的网址:。这个网址是需要注册的,注册就是要收费的,并且还是到按年收费的。在哪可以注册呢?目前国内域名的注册商...

2019-12-12

准备好开始您的项目了吗?

立即联系我们,获取专业的网站建设方案,让您的品牌在数字世界中脱颖而出