Android开发编码规范之注释（二）

Android开发编码规范之注释（二）

1.文件注释

/*
* —————————————————————–
* Copyright (C) 2007-2016, by YS100, Shenzhen, All rights reserved.
* —————————————————————–
*
* File: RequestManager.java
* Author: JiongBull
* Version: 1.0
* Create: 2016-6-10
*
* Changes (from 2016-6-10)
* —————————————————————–
* 2016-6-10 : 创建 RequestManager.java (JiongBull);
* —————————————————————–
*/

2.类注释

/**
 * description: 注册逻辑模块
 * Date: 2016/7/15 9:52
 * User: xiaobin
 */
public class RegisterModel {
    ...     }

3.方法注释

/**
 * 判断是否已经注册
 * @param mobile 手机号码
 * @return   返回网络请求结果
 */
public Observable<JsonResponse<String>>  isRegister(final String mobile){
    ... }

4.域变量和常量注释

/**
 * 下载书本的接口
 */
public static final String DOWNLOAD_TEXTBOOK_HTTP = API_IP + "english/rest/word/loadBook";

/**
 * 单词数据下载的接口
 */
public static final String DOWNLOAD_WORDS_HTTP = API_IP + "english/rest/word/LoadWord";

5.其他注释

规则 ：注释采用上斜杠，注释需要换行注释。
5.1、普通变量注释

//用户Id
private String mUserId;
//用户名称
private String mUserNickName;
//好友的ID
private String mFriendId;
//对手的名称
private String mFriendNickName;
//对手图标
private String mFriendIcon;
//问题的列举
private List<NoteProblems> listProblems;
//书本的ID
private int bookId;

5.2、在方法中注释

@Override
public void OnAnswerFinish() {
    if((mListWords.size()-1)<=mWordNumber) {
        //判断是从错词学习的还是单词学习
        if(!mAgainStudyflag){
            //添加分数,增加500分，并且更新分数
            int score = SharedPreferenceUtils.getInstance().getScore()+200;
            SharedPreferenceUtils.getInstance().setScore(score);
            ToastUtil.showShortToast(StudyActivity.this,getResources().getString(R.string.study_book_word_finish));
            mPersonCentreController.updateScore(Constant.sToken,Constant.sUesrId,String.valueOf(score));
            //清空学习记录，然后提交学习记录
            SharedPreferenceUtils.getInstance().saveTodayNumber(0);
            SharedPreferenceUtils.getInstance().saveWordId(mListWords.get(0).getWordId());
            SharedPreferenceUtils.getInstance().saveErrorNumberList("[]");
            SharedPreferenceUtils.getInstance().saveErrorWordList("[]");
            SharedPreferenceUtils.getInstance().saveSoftExitTime(DateTimeUtils.getDate2(0));
            //更新服务器进度
            HandleSevice.actionStudyUpdate(StudyActivity.this);

        }else{
            //不进行操作
            ToastUtil.showShortToast(StudyActivity.this,getResources().getString(R.string.study_word_finish));
        }
        return;
    }
    switchStudy(mListWords,  mWordNumber);
    mSelectWords.clear();
}

6. XML注释

    <!--版本更新按钮-->
    <Button
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:id="@+id/btn_version"
        android:text="@string/version_update"
        />