养成代码注释习惯,帮助你更好使用NetBeans导航器

  在使用NetBeans编写php代码时,为了在一个类中,或者在方法库文件中快速找到你想要找的函数或方法,通常我们会使用NetBeans的导航器。

  我们看一个导航器的事例:

  

  大家知道,在php中代码习惯是不会在声明变量的时候,说明变量类型的。

  但是如果在我们快速查询一个类库时,我们需要的只是怎么使用方法,并不需要知道方法在哪里和我们需要传递什么样的变量。

  所以通过阅读导航器,就能完成我们的查询工作,是最好的。

  首先看下面的代码:

  

  按照上面的说明

  只有按照上面注释的要点添加代码注释,才会出现在导航器中,显示传入变量类型和返回变量类型。

  

时间: 2024-10-05 12:49:43

养成代码注释习惯,帮助你更好使用NetBeans导航器的相关文章

如何养成每天敲代码的习惯

之前看的一篇国外大牛写下的东东,具体链接忘记了. 1.利用最小化的时间写好代码 强迫自己每天花不少于半个小时来写代码(这真不是一件容易的事,尤其还得回忆前一天写了什么),在工作日期间一般不超过一个小时,但是周末会多花一些时间来做业余项目. 2.让写代码成为习惯 不必关心排名,做业余项目是自己的事,不是为了取悦别人而做. 3.与不良情绪作斗争 在开始实施每天写代码的计划前期,常常会焦虑项目没有很大的进展,毕竟业余项目没有时间限制.但是要知道这样的不良情绪一点帮助都没有,反而会阻碍进度.所以与不良情

更精简的代码,更详细的注释,让项目更容易维护

更精简的代码,更详细的注释,让项目更容易维护,因为项目的本质不是代码,是算法,是实现步骤, 如果代码不精简,很臃肿,时间久了,具体实现过程会记忆模糊的,代码臃肿,以后是要花费更多时间读的. 有时可以在写的时候,就一边小重构一下,不要等到以后再重构 一精简重构的一些方式: 1抽取方法:抽取常用的功能,可以放到一些综合工具类里 2抽取变量:尤其是对于要用到很多if-else结构里的变量,可以先定义一个空变量,然后根据不同的情况, 进行赋值. 3砍掉变量:一个复杂系统肯定有很多的对象和变量,其实仔细思

Android 优化代码代码写作习惯代码规整

今天我想说说代码习惯: 刚开始学Android时相信很多新手都会有一个疑问,我们作为菜鸟除了技术上的不足到底哪点比不上大神呢?相信问这个问题的新手,肯定是一个不服输的人(不能叫愤青吧,我认 为愤青貌似是个贬义词)所以喜欢问问题,但是一些经验丰富的大神有的时候就会说自己百度,不行谷歌,这么简单的问题还问!这可能深深的伤害到我们菜鸟,但挺多时候是应 该我们自己动手找自己研究,其实作为菜鸟不是不喜欢动手自己找自己写,只是想有个捷径站在巨人的肩膀上,但是事实却不是这样的因为所有的问题要想记得更牢固,更清

代码注释中的5要与3不要

代码注释,可以说是比代码本身更重要.这里有一些方法可以确保你写在代码中的注释是友好的: 不要重复阅读者已经知道的内容 能明确说明代码是做什么的注释对我们是没有帮助的. 1 2 3 4 // If the color is red, turn it green if (color.is_red()) {   color.turn_green(); } 要注释说明推理和历史 如果代码中的业务逻辑以后可能需要更新或更改,那就应该留下注释:) 1 2 3 4 5 6 7 8 9 10 11 12 /* 

代码注释(Code comments)

代 码 注 释(Code comments) 在理解三层和机房三层+设计模式时,特别是三层运行时,师傅狠狠的指导了一 番,必须要一行一行运行原则,和怎么运行的,自己要能说出是怎么运行出来. 当初查 了一些网上资料,稂莠不齐,所以自己总结了一些代码注释的原则,还请多多指点: 代码的标准是英文,它的母语就是英文,现在不论是中国人.日本人还是俄国人在 开发软件,为了更好的理解和开发软件,都很有必要写一些相应的注释,为了更好的更 改.维护等工作,代码注释不是必须的,但是它可以提高程序的可读性,建议养成写

java开发规范总结_代码注释规范

规范需要平时编码过程中注意,是一个慢慢养成的好习惯 1.基本规则 1.注释应该使代码更加清晰易懂   2.注释要简单明了,只要提供能够明确理解程序所必要的信息就可以了.如果注释太复杂说明程序需要修改调整,使设计更加合理.   3.注释不仅描述程序做了什么, 还要描述为什么要这样做,以及约束   4.对于一般的getter.setter方法不用注释   5.注释不能嵌套   6.生成开发文档的需要用中文编写 2.三种注释方式说明 1.文档注释 /** */ 可以对用多行,一般用来对类.接口.成员方

Java代码注释

通过代码注释,可提高程序的可读性.注释中包含了程序的信息,可以帮助从程序员更好的阅读和理解程序.Java源文件的任意位置都可以添加注释语句.注释的文字Java编译器不进行编译,所有代码中的注释文字对程序不产生影响.Java提供了三种注释方法,分别为单行注释,多行注释,文档注释. 1 单行注释 "//"为单行注释的符号,从符号"//"开始到换行位置均为注释而被Java编译器忽略.语法如下:       //注释内容 例如:以下代码为声明int型变量添加注释. int

idea配置代码注释模板

从eclipse换成idea后,有点不习惯,其中之一就是代码注释,感觉不如eclipse好用,下面是一些配置方法,配完之后差不多能实现eclipse的效果. 1.以配置Class的注释为例,其他文件的类似,打开File - settings之后,找到下图的位置,选中Class后修改备注,变量和参数跟eclipse差不多就不多讲了.配置完这里后再新建class就会应用新的注释模板了,但是我也只能发现新建的时候应用,如果已有方法还是不会自动引用,只能手动维护. 可以随意定义自己的备注格式,这里只做演

静态网页代码书写习惯之我见

自学前端一个多月了,但是还没有完整地学习过一个电商网站的开发.这两天看了慕课网的视频“手把手教你电商网站开发”,觉得老师讲的很好,尤其是书写代码的习惯很好,总结如下: 第一:建立一个项目文件夹,里面包括html,css,js,images等文件夹,文件夹下面可以根据实际情况嵌套多个子文件夹和子文件,保证文件结构清晰有条理,同时要注意,文件夹和文件的命名最好有语义,让人一看就明白大概是什么. 第二:分析页面结构,即html框架,心里有谱后,然后开始书写,清晰优美的结构很重要. 第三:html大结构