如何使用routeConfig的ngDoc注释

时间:2015-05-01 07:54:19

标签: javascript angularjs documentation ngdoc

我正在尝试使用ngdocs和grunt记录我的Angular WebApp。我想知道有没有办法记录路由配置,因为我觉得我的WebApp路由系统相当复杂,需要在文档部分注意。

无论如何,我可以在控制器,工厂等级别上拥有它。

我可以将它放在下面的水平:

-(UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath {

  static NSString *cellIdentifier = @"socialMediaCell";    

  CustomSocialMediaTableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:cellIdentifier];

  CustomSocialMediaTableViewCell *tagCell = (CustomSocialMediaTableViewCell*)[tableView dequeueReusableCellWithIdentifier:@"socialMediaCell"];

  if (cell == nil) {

      cell = [[CustomSocialMediaTableViewCell alloc] 
        initWithStyle:UITableViewCellStyleDefault reuseIdentifier:cellIdentifier];

      tagCell = [[CustomSocialMediaTableViewCell alloc] initWithStyle:UITableViewCellStyleDefault reuseIdentifier:cellIdentifier];
  }

  NSData* imageData = [[NSUserDefaults standardUserDefaults] objectForKey:@"socialPosts"];

  UIImage* image = [UIImage imageWithData:imageData];

  cell.socialMediaTextView.text = @"TEXT";

  cell.socialMediaImageView.image = image;

  return cell;
}

谢谢, ANKIT

1 个答案:

答案 0 :(得分:1)

这样的事情怎么样才能让你入门?

这不是一个很好的答案,因为我还没有写过为@description撰写的内容,但希望这说明了一种开始使用ngdocs来记录路由的方法。

/**
 * @ngdoc overview
 * @name app.config:routes
 * @description
 *   Your description here.
 */
angular
  .module('app')
  .config(['$routeProvider', '$locationProvider', config]);

function config ($routeProvider, $locationProvider) {
  $routeProvider
    .when(
      templateUrl : 'app/example.view.html',
      controllerAs: 'example',
      controller  : 'ExampleController'
    )
    .otherwise({
      redirectTo: '/'
    });
}