商品详情注释统一

@@ -33,6 +33,6 @@ const getProductInfo = (req, res, next) => {
 };
 
 module.exports = {
-    index, // 组件demo页
-    getProductInfo
+    index, // 商品详情页
+    getProductInfo // 获取商品信息接口
 };

@@ -10,7 +10,9 @@ const helpers = global.yoho.helpers;
 
 /**
  * 使sizeBoList id以 sizeAttributeBos id顺序一样
- * @param sizeInfoBo
+ * @function _sizeInfoBoSort
+ * @param { Object } sizeInfoBo 尺码数据对象
+ * @return { Object } 返回正确排序的尺码信息
  */
 const _sizeInfoBoSort = sizeInfoBo => {
     if (!sizeInfoBo.sizeBoList || !sizeInfoBo.sizeAttributeBos) {
@@ -46,9 +48,11 @@ const _sizeInfoBoSort = sizeInfoBo => {
 
 /**
  * 处理限购商品的有关按钮状态（或取现购买以及底部商品购买按钮）
- * @param int uid
- * @param int showStatus 限购商品的关联状态
- * @param boolean isBeginSale 限购商品是否已开售
+ * @function _FashionTopGoodsStatus
+ * @param { string } uid 用户uid
+ * @param { number } showStatus 限购商品的关联状态
+ * @param { boolean } isBeginSale 限购商品是否已开售
+ * @return { Object } 潮流尖货状态
  */
 const _FashionTopGoodsStatus = (uid, showStatus, isBeginSale) => {
     // 潮流尖货状态
@@ -136,18 +140,17 @@ const _FashionTopGoodsStatus = (uid, showStatus, isBeginSale) => {
     return resData;
 };
 
+/**
+ * 设置SEO信息
+ * @function setSeoInfo
+ * @param { Object } goodInfo 商品信息
+ * @param { Object } nav 导航菜单信息
+ * @return { Object } 商品SEO信息
+ */
 const setSeoInfo = (goodInfo, nav) => {
     let brandName = _.get(goodInfo, 'brandName', ''),
         sortName = _.get(nav, '[1].name', '');
 
-    // if (goodInfo && goodInfo.brandName) {
-    //     brandName = goodInfo.brandName;
-    // }
-
-    // if (!_.isEmpty(nav) && nav[1]) {
-    //     sortName = nav[1].name;
-    // }
-
     return {
         title: `${brandName} ${sortName}|${goodInfo.name}正品`,
         keywords: `${brandName} ${sortName},${brandName}正品官网专卖店,${brandName}官方授权店,${brandName}正品,` +
@@ -156,6 +159,13 @@ const setSeoInfo = (goodInfo, nav) => {
     };
 };
 
+/**
+ * 处理商品详情面表屑导航
+ * @function setPathNav
+ * @param { Object } data 商品分类信息
+ * @param { string } name 商品名称
+ * @return { Object } 面包屑导航数据
+ */
 const setPathNav = (data, name) => {
     let resData = {};
 
@@ -203,8 +213,9 @@ const setPathNav = (data, name) => {
 
 /**
  * 设置品牌banner数据
- * @param  brand 品牌相关数据
- * @return Object
+ * @function setBrandBanner
+ * @param { Object } brand 品牌相关数据
+ * @return { Object } 品牌banner
  */
 const setBrandBanner = brand => {
     let data = {
@@ -225,9 +236,10 @@ const setBrandBanner = brand => {
 };
 
 /**
- * 设置商品数据
- * @param  base 商品基础数据
- * @return Object
+ * 设置商品基本信息
+ * @function setProductData
+ * @param { Object } base 接口返货商品数据
+ * @return { Object } 商品基本信息
  */
 const setProductData = base => {
     let resData = {
@@ -397,8 +409,9 @@ const setProductData = base => {
 
 /**
  * 设置品牌介绍
- * @param  brand 品牌相关数据
- * @return Object
+ * @function setBrandIntro
+ * @param { Object } brand 品牌相关数据
+ * @return { Object } 品牌介绍
  */
 const setBrandIntro = brand => {
     let barndIntro = {};
@@ -418,9 +431,10 @@ const setBrandIntro = brand => {
 
 /**
  * 设置商品描述
- * @param  sizeInfo
- * @param  comfortInfo
- * @return Object
+ * @function setDescriptionData
+ * @param { Object } sizeInfo 尺寸信息
+ * @param { Object } comfortInfo 试穿信息
+ * @return { Object } 商品描述
  */
 const setDescriptionData = (sizeInfo, comfortInfo) => {
     let resData = {};
@@ -504,8 +518,9 @@ const setDescriptionData = (sizeInfo, comfortInfo) => {
 
 /**
  * 设置洗涤材质信息
- * @param  sizeInfo
- * @return Object
+ * @function setMaterialData
+ * @param { Object } sizeInfo 尺寸信息
+ * @return { Object } 洗涤材质信息
  */
 const setMaterialData = sizeInfo => {
     let resData = {};
@@ -558,8 +573,9 @@ const setMaterialData = sizeInfo => {
 
 /**
  * 设置尺寸信息
- * @param  sizeInfo
- * @return Object
+ * @function setSizeData
+ * @param { Object } sizeInfo 尺寸信息
+ * @return { Object } 尺寸信息
  */
 const setSizeData = (sizeInfo) => {
     let resData = {};
@@ -691,9 +707,9 @@ const setSizeData = (sizeInfo) => {
 
 /**
  * 设置商品详情页介绍
- *
- * @param array sizeInfo
- * @return string
+ * @function setDetailData
+ * @param { Object } sizeInfo 尺寸信息
+ * @return { Object } 商品详情描述
  */
 const setDetailData = sizeInfo => {
     let resData = {};

@@ -12,6 +12,13 @@ const itemFUN = require('./item-handler');
 
 const search = require('./search-api');
 
+
+/**
+ * 根据商品基本信息获取商品品牌、材质、尺码、描述、详情等
+ * @function _getMultiResourceByBaseInfo
+ * @param { Object } 商品的基本信息
+ * @return { Object } 返回单个商品品牌、材质、尺码、描述、详情等信息
+ */
 const _getMultiResourceByBaseInfo = (base) => {
     let productId = base.id;
     let skn = base.erpProductId;
@@ -42,7 +49,15 @@ const _getMultiResourceByBaseInfo = (base) => {
     });
 };
 
-let getProductItemData = (params, url, uid) => {
+/**
+ * 获取商品基本信息、品牌、材质、尺码、描述、详情等
+ * @function getProductItemData
+ * @param { Object } 商品的参数
+ * @param { String } url 用户ID
+ * @param { String } uid 用户ID
+ * @return { Object } 返回单个商品的基本信息及品牌、材质、尺码、描述、详情等
+ */
+const getProductItemData = (params, url, uid) => {
     let pid = params[0];
 
     // let gid = params[1];