唐山设计公司:源代码注释样式:技巧和最佳实践

2019.09.12 唐山设计公司

128

唐山设计公司开发人员花任何时间在大型项目理解代码注释的重要性。 当你建造许多功能到相同的应用程序中,事情会变得复杂。 有很多数据位包括函数、变量引用,返回值,参数…你将保持如何?

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果它应该不足为奇评论代码是至关重要的,两个人和团队项目。 但许多开发人员都知道如何这个过程。 我提出一些我自己的个人技巧 创造整洁、格式化代码注释 . 标准和评论模板开发人员之间会有所不同,但最终你应该为之奋斗 清洁和可读的评论 进一步解释令人困惑的地区代码。

我们应该开始讨论一些不同的注释格式。 这将给你一个更好的主意是多么详细的你可以成为项目代码。 之后我将提供一些具体的建议和例子,你可以马上开始使用!

评论风格:概述

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果应该注意的是,这些想法只是 的指导方针 向更清洁的评论。 单独的编程语言不制定指南或规范如何设置您的文档。

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果话虽这么说,现代开发人员分组格式代码注释的他们自己的系统。 我将提供一些主流风格和详细的目的。

内联注释

几乎每一个编程语言提供 内联注释 . 这些是限于单行的内容,只有评论文本在某个点之后。 例如在C / c++内联开始评论是这样的:

1
2
3.
/ /变量清单开始
var myvar = 1;
. .

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果这是完美的协调到几秒钟的代码 解释可能混淆功能 . 如果你正在与大量的参数或函数调用你可能的地方附近一系列内联注释。 但最有益的使用是一个 简单的解释小功能 。


1
2
3.
如果(callAjax (美元的参数)){/ /成功运行callAjax与用户参数
 … 代码
}

注意上面的所有代码将需要一个新行开始后支架。 否则会被同一注释行! 避免走极端 因为你一般不需要看到单行注释所有的页面,但尤其是混淆连接在你的代码中,这些都是最后一分钟更容易下降。

描述性的块

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果当你需要包括一个大型的解释通常一个班轮是不会起作用的。 有预格式化评论模板用于编程的各个方面。 描述性的块 尤其是看到在功能和库文件。 当你安装一个新的函数是一种很好的做法 添加一个描述性的块以上声明 。

1
2
3.
4
5
6
7
8
/ * *
  * @desc打开一个模态窗口显示一条消息
  * @param味精-信息要显示的字符串
  * @return bool,成功或失败
* /
函数 modalPopup (美元味精){
}

以上是一个简单的描述性的功能注释的例子。 我写了一个函数可能在JavaScript调用 modalPopup这需要一个参数。 在上面的评论中我使用了相似的语法 phpDocumentor 每一行是之前在哪里 @象征,后跟一个选定的关键。 这些是不会以任何方式影响您的代码,所以您可以编写 @description而不是 @desc 没有任何变化。

这些小钥匙实际上是调用 注释标签 这是记录在网站上。 随时让自己和在代码中使用这些如你所愿。 我发现他们帮助保持一切流动 我可以检查重要信息一目了然 . 你也应该注意到我使用了 /* */方正评论格式。 这将使一切 干净了很多 比在每一行添加一个双斜杠开始。

集团/类的评论

除了评论功能和循环,块状区域并不经常使用。 你真的需要强大在哪里 块注释 在你的头后端文件或库文件。 很容易去全面,为每个文件编写可靠的文档在你的网站,我们可以看到这种做法在许多CMS等 WordPress 。

页面的顶端区域应持有评论关于文件本身。 这样你可以 快速检查你的编辑 当工作在多个页面在同一时间。 另外你可以使用这个区域 一个 数据库 你需要的最重要的功能 的类。

1
2
3.
4
5
6
7
/ * *
  * @desc这个类将用户交互的功能
  *的例子包括user_pass (), user_username (), user_age (), user_regdate ()
  * @author杰克Rocheleau jakerocheleau@gmail.com
  * @ required settings.php
* /
摘要 类 myWebClass {}

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果你能看到我用的只是一个小样本类假的 myWebClass 代码。 我添加了一些元数据信息 用我的名字和电子邮件地址联系 . 当开发人员编写开源的代码通常是好的做法,这样其他人可以联系你的支持。 这也是一个可靠的方法,在更大的开发团队。

标签 @ required 并不是我所见过的其他地方使用。 我跟上了格式在我的一些项目中,只在我的页面上定制的方法。 每当你到一个文件中必须包括页面来之前输出任何代码。 所以这些细节添加到主类注释块是一个好方法 还记得哪些文件是必要的 。

前端代码注释

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果现在我们已经介绍了三个重要评论模板,让我们来看看一些其他的例子。 有很多前端开发人员已经从静态的 超文本标记语言 成 jQuery 和 CSS 代码。 HTML注释没有有目的的编程应用程序相比,但当你写作风格库和页面脚本事情可能会变得混乱。

唐山设计公司

JavaScript遵循一个更传统的方法评论类似于Java、PHP和C / c++。 CSS只利用方正评论划定的削减和星号 . 你应该记住的评论将会公开显示给你的访客,因为CSS和javascript解析服务器端,但这两种方法适合于离开的花絮在代码中回到过去。

特别是分手CSS文件可以是一个苦差事。 我们都熟悉离开内联注释来解释修复ie和Safari。 但是我相信可以使用CSS评论在jQuery和PHP使用它们。 让我们深入研究创建样式组之前接触一些详细的代码注释的技巧。

CSS样式组

唐山设计公司对于那些多年来一直CSS设计几乎是第二天性。 你慢慢记住所有属性、语法和样式表构建自己的系统。 通过我自己的工作我创造了我所说的 分组 对类似CSS块到一个区域。

当回到编辑CSS我可以很容易的找到我所需要的东西在几秒钟。 你选择风格完全取决于你,这是此系统的优点。 我有一些预设标准我下面:

  • @resets——拿走默认浏览器利润率,填充、字体、颜色等。

  • @fonts——段落、标题、引用、链接代码

  • @navigation——的主要核心网站导航链接

  • 天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果@layout——包装、容器、工具条

  • @header & @footer——这些基于你的设计可能会有所不同。 可能的风格包括链接和无序列表,页脚列,标题、sub-navs

当分组样式表我已经找到了 标签系统 可以帮助很多。但是我与PHP和JavaScript使用一个吗@group 紧随其后的是一个类别或关键字标签。 我已经包括了下面两个例子,这样你就可以了解我的意思。

1
2
/ * * @group页脚* /
#页脚{风格…… }
1
/ * * @group页脚,小字体,列,外部链接* * /

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果你可以另外添加一些额外的细节在每一个注释块。 我选择 让事情简单明了 因此,样式表很容易浏览。 评论都是关于文档只要你理解写的好了!

4建议更好的评论样式

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果我们花费了本文的前半部分看各种格式的代码注释。 现在让我们讨论一些总体保持干净代码的建议,组织,容易理解。

1. 把所有可读

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果有时作为开发人员,我们忘记 我们为人类阅读写评论 . 的所有编程语言构建我们了解机器,所以它可以是乏味的转换成普通的书面文本。 重要的是要注意,我们不是在这里写一个大学水平的研究论文,但是 只留下小费 !

1
2
3.
4
5
6
7
8
9
函数 getTheMail () {
  / /这里的代码将建立电子邮件
 
  / *如果我们运行代码定制sendMyMail()函数调用返回true
     找到sendMyMail () / libs / mailer.class.php
     我们检查如果用户填写所有字段和消息发送! * /
  如果(sendMyMail ()) {返回 真正的;/ /保持真正成功并显示在屏幕上
    }
}

哪怕只是几句 总比没有好 . 当你回到编辑在未来项目的工作通常是令人惊讶的多少你会忘记。 因为你没有看相同的变量和函数名每天你会慢慢忘记大部分的代码。 因此你可以 不要让太多的评论 ! 但是你可以留下太多不好的评论。

一般的经验法则, 花一些时间在写作之前暂停和反映 . 问问你自己 最令人困惑的程序是什么 和 你怎么能最好在“虚拟”的语言解释一下吗 吗? 也可以考虑 为什么你写的代码完全一样吗 。

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果一些令人困惑的错误弹出当你忘记定制的目的(或第三方)的功能。 留下你的评论线索主要回几其他文件 如果这将帮助你记得功能更容易。

2. 减轻一些空间!

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果我不能强调足够的有多重要 空格 可以。 这是 双真正的 为PHP和Ruby开发人员正在大规模的网站与成百上千的文件。 你会整天盯着这段代码! 不是很好如果你可以浏览重要领域?

1
2
3.
dir美元1 =“/ home /”主要;/ / home目录
$ myCurrentDir = getCurDirr(); / /设置当前用户目录
userVar = get_username美元();/ /当前用户的用户名

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果在上面的例子中你会发现额外的注释和代码之间填充我放置在每一行。 当你翻阅文件,这种风格的评论 明显突出 . 它 使得更容易发现错误和纠正代码数百次 当变量的块 清洁 。

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果你可以执行类似的任务在一个函数的代码里面你困惑于它是如何工作的,但这种方法最终将杂物与内联注释你的代码,这是有序的完全相反! 我建议在这种情况下 大型钻井钢丝绳评论添加一个逻辑的面积 。

1
2
3.
4
5
6
7
8
9
10
11
12
13
$(文档)时函数(){
        $(“.sub”)hide ();/ /隐藏导航页面加载
     
        / * *检查锚.itm div内单击事件
              阻止默认动作的页面的链接点击不会改变
              访问.itm接下来的父元素.sub列表切换打开/关闭
        * * /
     
        $ ('。 itm一”).live ('点击”,函数(e) {
        e.preventDefault ();
        (美元).parent () . next ('.sub”).slideToggle ('快”);
       });
});

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果这是一个小的jQuery代码针对子菜单滑动导航。 第一个评论是内联来解释为什么我们隐藏的所有.sub 类。 以上现场点击事件处理程序我使用一块和发表评论 缩进所有写入相同的点 . 这使得事情更漂亮而不是流水段,特别是为别人阅读你的评论。

3. 评论同时编码

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果连同适当的间距,这可能是最好的习惯之一。 没人想回去之后他们的计划和记录每一件工作。 我们大多数人甚至不想回去和文档混乱地区! 这确实需要大量的工作。

comment while coding

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果但如果你能写的评论在你编码 一切在你的头脑中仍然是新鲜的 . 通常开发人员将被困在一个问题,在网络搜寻最简单的解决方案。 当你击中了尤里卡时刻和解决这样一个问题通常是一个时刻清晰,你理解你之前的错误。 这是 最佳时间 离开开放和诚实的评论你的代码。

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果另外这将给你练习适应评论你所有的文件。 所需的时间回去知道事情如何工作的更大后你已经建立了功能。 未来的自己和你的队友都将提前谢谢你留下评论 。

4. 处理车错误

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果我们不可能都坐在电脑前几个小时写代码。 我想我们可以试一试,但在某种程度上,我们需要睡眠! 你可能有一部分方法与代码的一些功能还坏了。 在这个场景中是至关重要的 离开久了,详细的评论,你留下的东西 。

checking code

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果即使一个新的觉你也许会很惊讶与困难是如何回到编码的摇摆。 例如,如果您正在构建一个图像上传页面,不得不离开它未完成,你 评论,在这个过程中你应该离开吗 . 图片上传和存储在临时记忆? 或者他们甚至不承认在上传表单,或者他们是上传后不能正常显示在页面上。

天线宝宝第一高手论坛-tt538天线宝宝开奖结果-天线宝宝论坛精选资料专区-天线宝宝论坛开奖结果评论的错误是非常重要的两个主要原因。 首先你可以 容易接你离开的地方 和 再试一次新鲜的头脑解决问题(s) . 其次你可以 区分你网站的生产版本和测试 . 记住,应该用于评论 解释为什么你正在做的事情 ,而不是什么。

结论

唐山设计公司开发web应用程序和软件是一种满足的做法,尽管是一个难以解决的问题。 如果你是为数不多的几个开发人员真正理解构建软件然后成熟与你的编程技能是很重要的。 离开描述性注释只是长期良好的实践 ,你可能永远不会后悔!


最新案例

联系电话 400-6065-301
赚钱高手两组三中三-三中三复式计算公式-三码中特全免费公开码 本港台现场报码直播j2-本港开奖结果现场开码-本港台现场搅珠直播 正版管家婆一句赢大钱-www管家婆27735com-管家婆小鱼儿论坛心水 九龙心水三肖永不改料-九龙心水525757com-九龙老牌图库彩图大全 澳门123696com开奖结果-626969cc澳门资料大全-2021澳门合彩开彩结果