养成代码注释习惯,帮助你更好使用NetBeans导航器
2015-01-12 18:01
459 查看
在使用NetBeans编写php代码时,为了在一个类中,或者在方法库文件中快速找到你想要找的函数或方法,通常我们会使用NetBeans的导航器。
我们看一个导航器的事例:
大家知道,在php中代码习惯是不会在声明变量的时候,说明变量类型的。
但是如果在我们快速查询一个类库时,我们需要的只是怎么使用方法,并不需要知道方法在哪里和我们需要传递什么样的变量。
所以通过阅读导航器,就能完成我们的查询工作,是最好的。
首先看下面的代码:
按照上面的说明
只有按照上面注释的要点添加代码注释,才会出现在导航器中,显示传入变量类型和返回变量类型。
我们看一个导航器的事例:
大家知道,在php中代码习惯是不会在声明变量的时候,说明变量类型的。
但是如果在我们快速查询一个类库时,我们需要的只是怎么使用方法,并不需要知道方法在哪里和我们需要传递什么样的变量。
所以通过阅读导航器,就能完成我们的查询工作,是最好的。
首先看下面的代码:
按照上面的说明
只有按照上面注释的要点添加代码注释,才会出现在导航器中,显示传入变量类型和返回变量类型。
相关文章推荐
- vs2010代码注释自动生成api文档(Sandcastle帮助文档生成器使用介绍)
- .NET开发需要养成一种良好的注释代码习惯篇
- 使用GhostDoc为代码生成注释文档
- 在有源代码的情况下注释ComponentArt的许可证检查,彻底无风险使用ComponentArt
- VC使用技巧:让你团队里所有人在编译工程时都要看你的代码注释
- 使用SandCastle和HTML Help 2.0集成XML代码注释到VS2005和VS2008
- 使用 JET 在 Eclipse 中创建更多更好的代码,如何掌握专家的最佳实践并提高您的模型驱动开发进度
- C# 学习笔记 -- 第二天 使用注释提高代码可读性
- 从寻找资源的习惯上谈如何获得好的代码及控件(使用Koders查找)
- 使用SandCastle和HTML Help 2.0集成XML代码注释到VS2005和VS2008
- 养成使用jQuery Sizzle选择器的良好习惯
- 养成使用jQuery Sizzle选择器的良好习惯
- 帮助子女养成良好的读书习惯 胜过1000亿财富
- 自己收集整理的 DELPHI 中控制与使用HMTL帮助文件的单元代码。
- .Net开发必备十大工具详解之使用GhostDoc为代码生成注释文档
- 使用.NET中的XML注释(二) -- 创建帮助文档入门篇
- 在有源代码的情况下注释ComponentArt的许可证检查,彻底无风险使用ComponentArt
- 使用SandCastle和HTML Help 2.0集成XML代码注释到VS2005和VS2008
- c#使用接口--帮助你更好的理解接口(转载)
- 使用.NET中的XML注释(二) -- 创建帮助文档入门篇