增加一些注释

Author: CarGuo

lib/main.dart

@@ -113,6 +113,8 @@ class _GSYLocalizations extends State<GSYLocalizations> {
   @override
   void initState() {
     super.initState();
+
+    ///Stream演示event bus
     stream = eventBus.on<HttpErrorEvent>().listen((event) {
       errorHandleFunction(event.code, event.message);
     });
@@ -127,6 +129,7 @@ class _GSYLocalizations extends State<GSYLocalizations> {
     }
   }
 
+  ///网络错误提醒
   errorHandleFunction(int code, message) {
     switch (code) {
       case Code.NETWORK_ERROR:

lib/page/dynamic_page.dart

@@ -28,6 +28,7 @@ class _DynamicPageState extends State<DynamicPage>
         WidgetsBindingObserver {
   final DynamicBloc dynamicBloc = new DynamicBloc();
 
+  ///控制列表滚动和监听
   final ScrollController scrollController = new ScrollController();
 
   /// 模拟IOS下拉显示刷新
@@ -64,7 +65,9 @@ class _DynamicPageState extends State<DynamicPage>
   @override
   void initState() {
     super.initState();
+    ///监听生命周期，主要判断页面 resumed 的时候触发刷新
     WidgetsBinding.instance.addObserver(this);
+    ///获取网络端新版信息
     ReposDao.getNewsVersion(context, false);
   }
 
@@ -82,6 +85,7 @@ class _DynamicPageState extends State<DynamicPage>
     super.didChangeDependencies();
   }
 
+  ///监听生命周期，主要判断页面 resumed 的时候触发刷新
   @override
   void didChangeAppLifecycleState(AppLifecycleState state) {
     if (state == AppLifecycleState.resumed) {
@@ -110,6 +114,8 @@ class _DynamicPageState extends State<DynamicPage>
     super.build(context); // See AutomaticKeepAliveClientMixin.
     return new StoreBuilder<GSYState>(
       builder: (context, store) {
+        ///BlocProvider 用于管理 bloc 共享，如果不需要共享可以不用
+        ///直接 StreamBuilder 配合即可
         return BlocProvider<DynamicBloc>(
           bloc: dynamicBloc,
           child: GSYPullLoadWidget(

lib/page/home_page.dart

@@ -24,6 +24,7 @@ class HomePage extends StatelessWidget {
 
   /// 不退出
   Future<bool> _dialogExitApp(BuildContext context) async {
+    ///如果是 android 回到桌面
     if (Platform.isAndroid) {
       AndroidIntent intent = AndroidIntent(
         action: 'android.intent.action.MAIN',
@@ -52,6 +53,7 @@ class HomePage extends StatelessWidget {
       _renderTab(GSYICons.MAIN_QS, CommonUtils.getLocale(context).home_trend),
       _renderTab(GSYICons.MAIN_MY, CommonUtils.getLocale(context).home_my),
     ];
+    ///增加返回按键监听
     return WillPopScope(
       onWillPop: () {
         return _dialogExitApp(context);

lib/page/issue_detail_page.dart

@@ -16,6 +16,7 @@ import 'package:gsy_github_app_flutter/widget/issue_header_item.dart';
 import 'package:gsy_github_app_flutter/widget/issue_item.dart';
 
 /**
+ * Issue 详情页面
  * Created by guoshuyu
  * on 2018/7/21.
  */
@@ -42,20 +43,24 @@ class _IssueDetailPageState extends State<IssueDetailPage>
         GSYListState<IssueDetailPage> {
   int selectIndex = 0;
 
+  ///头部信息数据是否加载成功，成功了就可以显示底部状态
   bool headerStatus = false;
 
+  /// issue 的头部数据显示
   IssueHeaderViewModel issueHeaderViewModel = new IssueHeaderViewModel();
 
+  ///控制编辑时issue的title
   TextEditingController issueInfoTitleControl = new TextEditingController();
 
+  ///控制编辑时issue的content
   TextEditingController issueInfoValueControl = new TextEditingController();
 
-  final TextEditingController issueInfoCommitValueControl =
-      new TextEditingController();
-
+  ///标题栏右侧显示控制
   final OptionControl titleOptionControl = new OptionControl();
 
+  ///绘制item
   _renderEventItem(index) {
+    ///第一个绘制的是头部
     if (index == 0) {
       return new IssueHeaderItem(issueHeaderViewModel, onPressed: () {});
     }
@@ -113,7 +118,9 @@ class _IssueDetailPageState extends State<IssueDetailPage>
     );
   }
 
+  ///获取页面数据
   _getDataLogic() async {
+    ///刷新时同时更新头部信息
     if (page <= 1) {
       _getHeaderInfo();
     }
@@ -122,6 +129,7 @@ class _IssueDetailPageState extends State<IssueDetailPage>
         page: page, needDb: page <= 1);
   }
 
+  ///获取头部数据
   _getHeaderInfo() {
     IssueDao.getIssueInfoDao(widget.userName, widget.reposName, widget.issueNum)
         .then((res) {
@@ -137,6 +145,7 @@ class _IssueDetailPageState extends State<IssueDetailPage>
     });
   }
 
+  ///数据转化显示
   _resolveHeaderInfo(res) {
     Issue issue = res.data;
     setState(() {
@@ -146,6 +155,7 @@ class _IssueDetailPageState extends State<IssueDetailPage>
     });
   }
 
+  ///编辑回复
   _editCommit(id, content) {
     Navigator.pop(context);
     String contentData = content;
@@ -179,6 +189,7 @@ class _IssueDetailPageState extends State<IssueDetailPage>
     );
   }
 
+  ///删除回复
   _deleteCommit(id) {
     Navigator.pop(context);
     CommonUtils.showLoadingDialog(context);
@@ -191,6 +202,7 @@ class _IssueDetailPageState extends State<IssueDetailPage>
     });
   }
 
+  ///编译 issue
   _editIssue() {
     String title = issueHeaderViewModel.issueComment;
     String content = issueHeaderViewModel.issueDesHtml;
@@ -234,6 +246,7 @@ class _IssueDetailPageState extends State<IssueDetailPage>
     );
   }
 
+  ///回复 issue
   _replyIssue() {
     //回复 Info
     issueInfoTitleControl = new TextEditingController(text: "");
@@ -269,6 +282,7 @@ class _IssueDetailPageState extends State<IssueDetailPage>
     );
   }
 
+  ///获取底部状态控件显示
   _getBottomWidget() {
     List<Widget> bottomWidget = (!headerStatus)
         ? []

lib/page/login_page.dart

@@ -51,7 +51,9 @@ class _LoginPageState extends State<LoginPage> {
 
   @override
   Widget build(BuildContext context) {
+    ///共享 store
     return new StoreBuilder<GSYState>(builder: (context, store) {
+      /// 触摸收起键盘
       return new GestureDetector(
         behavior: HitTestBehavior.translucent,
         onTap: () {
@@ -61,8 +63,9 @@ class _LoginPageState extends State<LoginPage> {
           body: new Container(
             color: Theme.of(context).primaryColor,
             child: new Center(
-              //防止overFlow的现象
+              ///防止overFlow的现象
               child: SafeArea(
+                ///同时弹出键盘不遮挡
                 child: SingleChildScrollView(
                   child: new Card(
                     elevation: 5.0,

lib/page/my_page.dart

@@ -32,20 +32,23 @@ class _MyPageState extends BasePersonState<MyPage> {
     return StoreProvider.of(context);
   }
 
+  ///从全局状态中获取我的用户名
   _getUserName() {
     if (_getStore()?.state?.userInfo == null) {
       return null;
     }
     return _getStore()?.state?.userInfo?.login;
   }
 
+  ///从全局状态中获取我的用户类型
   getUserType() {
     if (_getStore()?.state?.userInfo == null) {
       return null;
     }
     return _getStore()?.state?.userInfo?.type;
   }
 
+  ///更新通知图标颜色
   _refreshNotify() {
     UserDao.getNotifyDao(false, false, 0).then((res) {
       Color newColor;
@@ -91,8 +94,12 @@ class _MyPageState extends BasePersonState<MyPage> {
           //todo getUserOrg(_getUserName());
         }
       });*/
+      ///通过 redux 提交更新用户数据行为
+      ///触发网络请求更新
       _getStore().dispatch(FetchUserAction());
+      ///获取用户组织信息
       getUserOrg(_getUserName());
+      ///获取用户仓库前100个star统计数据
       ReposDao.getUserRepository100StatusDao(_getUserName()).then((res) {
         if (res != null && res.result) {
           if (isShow) {

lib/page/notify_page.dart

@@ -32,11 +32,14 @@ class _NotifyPageState extends State<NotifyPage>
 
   _NotifyPageState();
 
+  ///绘制 Item
   _renderItem(index) {
     Model.Notification notification = pullLoadWidgetControl.dataList[index];
     if (selectIndex != 0) {
       return _renderEventItem(notification);
     }
+
+    ///只有未读消息支持 Slidable 滑动效果
     return new Slidable(
       key: ValueKey<String>(index.toString() + "_" + selectIndex.toString()),
       controller: slidableController,
@@ -63,6 +66,7 @@ class _NotifyPageState extends State<NotifyPage>
     );
   }
 
+  ///绘制实际的内容数据item
   _renderEventItem(Model.Notification notification) {
     EventViewModel eventViewModel =
         EventViewModel.fromNotify(context, notification);
@@ -85,6 +89,7 @@ class _NotifyPageState extends State<NotifyPage>
     }, needImage: false);
   }
 
+  ///切换tab
   _resolveSelectIndex() {
     clearData();
     showRefreshLoading();

lib/page/person_page.dart

@@ -46,6 +46,7 @@ class _PersonState extends BasePersonState<PersonPage> {
 
   _PersonState(this.userName);
 
+  ///处理用户信息显示
   _resolveUserInfo(res) {
     if (isShow) {
       setState(() {
@@ -62,6 +63,7 @@ class _PersonState extends BasePersonState<PersonPage> {
     }
     isLoading = true;
     page = 1;
+    ///获取网络用户数据
     var userResult = await UserDao.getUserInfo(userName, needDb: true);
     if (userResult != null && userResult.result) {
       _resolveUserInfo(userResult);
@@ -73,6 +75,7 @@ class _PersonState extends BasePersonState<PersonPage> {
     } else {
       return null;
     }
+    ///获取用户动态或者组织成员
     var res = await _getDataLogic();
     resolveRefreshResult(res);
     resolveDataResult(res);
@@ -82,7 +85,9 @@ class _PersonState extends BasePersonState<PersonPage> {
       resolveDataResult(resNext);
     }
     isLoading = false;
+    ///获取当前用户的关注状态
     _getFocusStatus();
+    ///获取用户仓库前100个star统计数据
     ReposDao.getUserRepository100StatusDao(_getUserName()).then((res) {
       if (res != null && res.result) {
         if (isShow) {
@@ -95,6 +100,7 @@ class _PersonState extends BasePersonState<PersonPage> {
     return null;
   }
 
+  ///获取当前用户的关注状态
   _getFocusStatus() async {
     var focusRes = await UserDao.checkFollowDao(userName);
     if (isShow) {
@@ -107,13 +113,15 @@ class _PersonState extends BasePersonState<PersonPage> {
     }
   }
 
+  ///获取用户信息里的用户名
   _getUserName() {
     if (userInfo == null) {
       return new User.empty();
     }
     return userInfo.login;
   }
 
+  ///获取用户动态或者组织成员
   _getDataLogic() async {
     if (userInfo.type == "Organization") {
       return await UserDao.getMemberDao(_getUserName(), page);
@@ -152,6 +160,7 @@ class _PersonState extends BasePersonState<PersonPage> {
         floatingActionButton: new FloatingActionButton(
             child: new Text(focus),
             onPressed: () {
+              ///非组织成员可以关注
               if (focus == '') {
                 return;
               }

lib/page/push_detail_page.dart

@@ -1,12 +1,10 @@
 import 'dart:async';
 import 'dart:convert';
-import 'dart:io';
 
 import 'package:flutter/material.dart';
 import 'package:gsy_github_app_flutter/common/dao/repos_dao.dart';
 import 'package:gsy_github_app_flutter/common/model/PushCommit.dart';
 import 'package:gsy_github_app_flutter/common/style/gsy_style.dart';
-import 'package:gsy_github_app_flutter/common/utils/common_utils.dart';
 import 'package:gsy_github_app_flutter/common/utils/navigator_utils.dart';
 import 'package:gsy_github_app_flutter/widget/gsy_common_option_widget.dart';
 import 'package:gsy_github_app_flutter/widget/state/gsy_list_state.dart';
@@ -17,6 +15,7 @@ import 'package:gsy_github_app_flutter/widget/push_header.dart';
 import 'package:gsy_github_app_flutter/common/utils/html_utils.dart';
 
 /**
+ * 提交信息详情页
  * Created by guoshuyu
  * Date: 2018-07-27
  */
@@ -38,8 +37,10 @@ class PushDetailPage extends StatefulWidget {
 
 class _PushDetailPageState extends State<PushDetailPage> with AutomaticKeepAliveClientMixin<PushDetailPage>, GSYListState<PushDetailPage> {
 
+  ///提价信息页面的头部数据实体
   PushHeaderViewModel pushHeaderViewModel = new PushHeaderViewModel();
 
+  ///配置标题了右侧的更多显示
   final OptionControl titleOptionControl = new OptionControl();
 
   _PushDetailPageState();
@@ -51,6 +52,7 @@ class _PushDetailPageState extends State<PushDetailPage> with AutomaticKeepAlive
     }
     isLoading = true;
     page = 1;
+    ///获取提交信息
     var res = await _getDataLogic();
     if (res != null && res.result) {
       PushCommit pushCommit = res.data;
@@ -68,6 +70,7 @@ class _PushDetailPageState extends State<PushDetailPage> with AutomaticKeepAlive
     return null;
   }
 
+  ///绘制头部和提交item
   _renderEventItem(index) {
     if (index == 0) {
       return new PushHeader(pushHeaderViewModel);

lib/page/release_page.dart

@@ -37,12 +37,13 @@ class ReleasePage extends StatefulWidget {
 
 class _ReleasePageState extends State<ReleasePage> with AutomaticKeepAliveClientMixin<ReleasePage>, GSYListState<ReleasePage> {
 
+  ///配置标题了右侧的更多显示
   final OptionControl titleOptionControl = new OptionControl();
 
+  ///显示tag还是relase
   int selectIndex = 0;
 
-  _ReleasePageState();
-
+  ///绘制item
   _renderEventItem(index) {
     ReleaseItemViewModel releaseItemViewModel = ReleaseItemViewModel.fromMap(pullLoadWidgetControl.dataList[index]);
     return new ReleaseItem(
@@ -69,6 +70,7 @@ class _ReleasePageState extends State<ReleasePage> with AutomaticKeepAliveClient
     );
   }
 
+  ///打开外部url
   _launchURL() async {
     String url = _getUrl();
     if (await canLaunch(url)) {