//
//  commentStandard.swift
//  ZhiQianJia
//
//  Created by li fu on 2017/8/17.
//  Copyright © 2017年 LiFu. All rights reserved.
//
//本文件主要做注释规范作用，无任何实际方法


import Foundation

/// 用户信息
struct UserInfo {
    /// 昵称
    var nickname: String
    /// 性别 ture: 男,  false: 女
    var isMale: Bool
    
}

/// 注释规范参考
class CommentStandard {
    
    /// 文档注释参考 【单行】
    /// - parameter pram: 单参数
    /// - returns : 返回结果是否成功 ture： 成功  false: 失败
    ///
    /// 其他dissions 详细说明  // 注意必须隔一行
    func singleLineComment(pram:String) -> Bool {
        print("注释参考")
        return true
    }
    /**
     # 支持markdown
     # 一级标题
     ## 二级标题也可以的
     注释参考2
     隔一行表示换行d
     
     三个”***"代表一条分割线
     ***
     ## 使用示例
     ```
     let result = testComment2(pram: "参数1", param2: true))
     ```
     
     ****
     - important:这个很重要
     - returns: 有返回值
     - parameter pram: The cubes available for allocation
     - parameter param2: The people that require cubes
     
     */
    func testComment2(pram:String, param2:Bool) -> Bool {
        print("markdown支持")
        return true
    }
    
    /**
     文档注释参考 【多行注释】  // 【注意：必须新起一行】
     - parameter p1: The number of Llamas spotted on the trip
     - parameter p2: The number of Llamas spotted on the trip
     - returns: 返回结果字符串数组
     
     其他discussion说明  // 【注意】同样必须隔一行
     */
    func text(p1:String , p2:Bool) -> [String] {
        return [String]()
        
    }
    
    /**
     *  OC常规注释
     *
     *    @param    param1    参数1
     *    @param    param2    参数2
     */
    
    
    //MARK: - 1、标注标准
    
    //MARK: - 标注，适合文件内分模块
    //TODO: - 未完成功能
    //!!!: - 警告
    //???: - 不满/建议/疑问（修改者使用）
    
    //MARK: - 2、普通注释
    //
    /**/
    
    //MARK: - 3.文档规范注释（可文档化[工具：HeaderDoc(官方)、AppleDoc（通用性强【我使用】）、Docxygen]、Quick Help）
    //使用说明链接：http://www.jianshu.com/p/29c0fef37d69
    //HeaderDoc 支持只/*!  */的格式， AppleDoc 支持/*! */ 和/**  */ 格式生成文档
    
    //合格注释的标准：a.Alt + 单击 唤醒Quick Help   b.单击方法在Quick Help 可查看  c.可文档化
    
    //可文档化的要求：
    //行尾注释：Docxygen支持 ，另外QuickHelp也支持，   建议使用形式： //!<
    //如：
    //!<
    func test(string:String){
        print("测试行尾注释")
    }
    /*
     ///      :行首单行注释【HeaderDoc不支持】
     //!<     :行尾单行注释【Docxygen支持 ，另外QuickHelp也支持，AppleDoc应避免】
     /** */   :多首多行注释【HeaderDoc不支持】
     */
    
    //MARK: - 通用二级标签
    /** 简要描述
     * 详细描述
     */
    ///简要描述.详细描述
    
    //MARK: -  AppleDoc 和 Doxygen 均支持的常用二级标签
    /**
     * @brief <title>: 简要注释. appledoc中仅对属性、方法有效，对类、协议 无效，会造成后续内容解析失败.
     * @param <name> <description>: 参数描述.
     * @return <description>: 返回值描述.
     * @exception <name> <description>: 异常描述.
     * @see <name>: 参见.
     * @sa <name>: 参见. 同@see.
     * @warning <text>: 警告.
     * @bug <text>: 警告.
     * @name <title>: 组名. 用于给成员们分组, 既文档中Tasks区的子类别.
     * 代码块 `int sum = 0;`
     * 多行代码块:
     *     int sum = 0;
     *     for(int i = 1; i <= 10; i++) {
     *         sum += i;
     *     }
     * 无序列表:
     * - first
     * - second
     * - third
     * 有序列表:
     * 1. first
     * 2. second
     * 3. third
     * 多级列表:
     * - abc
     *    - a
     *    - b
     *    - c
     * - rgb
     *    - red
     *        1. first.
     *            1. alpha.
     *            2. beta.
     *        2. second.
     *        3. third.
     *    - green
     *    - blue
     * 链接:
     * <http://www.xuyafei.cn>
     * [xuyafei](<http://www.xuyafei.cn>)
     */
    //MARK -  Quick Help 支持的常用二级标签
    /**
     * @brief It converts temperature degrees from Celsius to Fahrenheit scale.
     * @param  fromCelcius The celsius degrees value.
     * @return float The degrees in the Fahrenheit scale.
     * @code
     *     float f = [self toCelsius:80];
     * @endcode
     * @remark This is a super-easy method.
     */
    
    
    
}