您的位置：首页 > 移动开发 > Android开发

Java和Android注释规范

2014-09-29 11:15 183 查看
1、文件头注释

每一个文件的文件头都必须做文件头注释。文件头注释范例如下：



/*
*文件名：LoginActivity
*描述：对用户
*作者：
*时间：
*版权：
*/








2、方法头注释

每一个成员方法（包括自定义成员方法、覆盖方法、属性方法）的方法头都必须做方法头注释。

自定义成员方法注释范例如下：

/*
*方法名：login_Click(Viewv)
*功能：单击登录按钮的事件
*参数：Viewv-按钮的View
*返回值：无
*/




覆盖（重写）成员方法注释范例如下：



属性getter和setter成员方法注释范例如下：



3、块注释

在实现一段阶段性功能的代码前做块注释。块注释的注释范例如下：



4、变量注释

所有的成员变量和大多数局部变量在声明时都需要为其做功能注释。

成员变量注释的注释范例如下：



局部变量注释的注释范例如下：



5、语句注释

在关键语句的右侧要做单条语句注释。

语句注释的注释范例如下：



6、有关注释的其它说明

（1）文件头和方法头注释应该使用/**/形式，变量注释和语句注释应该使用//形式，块注释应尽量使用//形式，当文字较长（单屏横向不能显示完全）时块注释也可以使用/**/形式；

（2）注释量必须不少于代码总量的三分之一；
                                            

                                        

                        
                        内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 点击这里给我发消息 
                    

                    

                    

                        

                         标签： 
                                                

                        

                    


                

            


            

                
相关文章推荐

                

                
            

        

        

            

            
            

                

                    
新的分享

                    

                        
                    

                

            


            

                

                    
章节导航