总结:菜谱项目最终要点

主要我们是要编写一个文档,让我们的代码更加的易于理解,也让其他的开发人员更快的看懂我们的代码

  • 这里我们采用JSDOC的标准方法来撰写文档,我们可以从官网中了解更多的信息

总结:菜谱项目最终要点_第1张图片

  • 这里我们显示一样,一般情况下再vscode中输入/** */

总结:菜谱项目最终要点_第2张图片

  • 之后我们选择这个JSDOC注释的话,就可以了自动出现
  /**
   * 
   * @param {*} data 
   * @param {*} render 
   * @returns 
   */
  • 这个是什么意思呢,意思就是这个在文档中注明这个值需要一个什么类型,也可以加上具体有什么样的作用,例如:
  /**
   * 将接受到的对象渲染到DOM中
   * @param {Object | Object[]} data 这个数据将被渲染(例如一个菜谱)
   * @param {boolean} [render = true] 如果是flase,将创建一个标记字符串,而不是渲染到DOM中
   * @returns
   */

这样做的好处就是,如果这个项目是很多人共同开发的,如果大家也都用这种方式来撰写项目文档的话,那么很快别人就是了解你的代码了

  • 撰写好之后,将鼠标放入这个参数中,就会进行提示

在这里插入图片描述

  • 除此之外,我们也可以增加一下其他的信息,例如这些参数返回了什么,this指向什么,作者是谁,这个项目下一步应该做什么,至于可以添加哪些参数,上面给你的网站中都有详细的解释
  /**
   * 将接受到的对象渲染到DOM中
   * @param {Object | Object[]} data 这个数据将被渲染(例如一个菜谱)
   * @param {boolean} [render = true] 如果是flase,将创建一个标记字符串,而不是渲染到DOM中
   * @returns {undefined | string} 如果render = false ,那么一个标记字符串将被返回
   * @this {Object} 视图实例
   * @author Jonas Schmedmann
   * @todo 完成了所有实现
   */

改进和创意挑战

  • 在分页按钮之间显示页数(这样可以让用户看到后面最终还有多少页,让客户有个心理预期)
  • 能够按持续时间或成分数量对搜索结果进行排序。(对于用户体验来说,这样的搜索功能更加人性化)
  • 在表单的视图中,我们需要验证一下成分,然后再进行提交的操作;
  • 改进食谱成分输入:在多个字段中分离,并允许超过6种成分;
  • 购物清单功能:在食谱上添加按钮以将食材添加到列表中;
  • 每周餐计划功能:将食谱分配到接下来的7天,并在周历上显示:
  • 从SpoonacularAPl(https://spoonacular.com/food-api)获取每种成分的营养数据,并计算该食谱的总卡路里。

可能这个部分的功能实现起来确实有难度,但是完全可以自己尝试一下,下面,我们会将这个项目部署到实时的服务器中,以便我们可以更好的分享我们的项目;所以这并不只是结束,还有很多有趣的好玩的东西需要我们学习;加粗样式

你可能感兴趣的:(JavaScript,javascript)