草庐IT

JSDOC-设置类型而无需导入文件

我在VSCODE中使用了Angular1。我有一个主文件,可以定义我的所有服务,控制器等require他们反对角。angular.module('myApp',[]).service('myService',require('./myService.js').controller('myController',require('./myController.js');和服务:classMyService{constructor(){}}module.exports=MyService;和我的控制器classMyController{constructor(myService){/**@type

JSDoc

JSDoc是许多代码库中使用的一种流行的内联文档方法。编写JSDoc是为了增强代码的可读性,以及方便导出API文档。为什么要使用JSDoc?JSDoc是DocBlock的JavaScript实现,DocBlock是一种用于各种编程语言(包括PHP、Ruby和Python)的文档方法。它提供了一种一致且可识别的文档方法。还有几个工具可以根据JSDoc注释自动生成文档。将文档注释添加到您的代码JSDoc的目的是记录您的JavaScript应用程序或库的API。假设您需要为模块、命名空间、类、方法和方法参数等内容添加注释。最简单的方法是创建一个带有两个前导星号(/**)的注释,以及对函数功能的描述。

前端开发何必执着于Typescript?Jsdoc一样很好用

为什么很多公司执着于typescript?因为typescript支持很多JS不支持的特性,正确的使用typescript,可以使你的代码更易于维护。最主要的是可以给JS添加类型,使编辑器的提示更智能。但是,typescript是很复杂的一门语言,很多开发者并不能很好的运用typescript,甚至很多人是被迫的,他们内心是反感使用typescript的,导致代码写的乱七八糟。事实上,JS也有很多优势是typescript所不具备的,比如:JS的灵活性很高。如果我告诉你,有一种工具,完全可以像写typescript一样写JS,你会用吗?我说的这个工具就是jsdoc,我们可以叫它JS文档注释。它

javascript - 如何在 JSDoc 中记录字典?

有下一个例子:varCONF={locale:{"en":{name:"English",lang:"en-US"},"es":{name:"Spanish",lang:"es-ES"}}};知道locale属性包含的是一个字典对象,它来自数据库,我如何用JSDoc记录它的内部属性?目前我正在考虑为我的语言环境对象输入typedef类型,那么我是否可以将locale属性设置为我定义类型的简单数组?这是正确的做法吗? 最佳答案 根据JSDoc3docs:Arraysandobjects(typeapplicationsandrecor

javascript - 如何在 JSDoc 中记录字典?

有下一个例子:varCONF={locale:{"en":{name:"English",lang:"en-US"},"es":{name:"Spanish",lang:"es-ES"}}};知道locale属性包含的是一个字典对象,它来自数据库,我如何用JSDoc记录它的内部属性?目前我正在考虑为我的语言环境对象输入typedef类型,那么我是否可以将locale属性设置为我定义类型的简单数组?这是正确的做法吗? 最佳答案 根据JSDoc3docs:Arraysandobjects(typeapplicationsandrecor

javascript - 使用 jsdoc 记录匿名对象和函数的最佳方式

编辑:从技术上讲,这是一个由两部分组成的问题。我选择了涵盖一般问题的最佳答案,并链接到处理特定问题的答案。使用jsdoc记录匿名对象和函数的最佳方式是什么?/***@class{Page}PageClassspecification*/varPage=function(){/***Getapagefromtheserver*@param{PageRequest}pageRequestInfoonthepageyouwanttorequest*@param{function}callbackFunctionexecutedwhenpageisretrieved*/this.getPage

javascript - 使用 jsdoc 记录匿名对象和函数的最佳方式

编辑:从技术上讲,这是一个由两部分组成的问题。我选择了涵盖一般问题的最佳答案,并链接到处理特定问题的答案。使用jsdoc记录匿名对象和函数的最佳方式是什么?/***@class{Page}PageClassspecification*/varPage=function(){/***Getapagefromtheserver*@param{PageRequest}pageRequestInfoonthepageyouwanttorequest*@param{function}callbackFunctionexecutedwhenpageisretrieved*/this.getPage

javascript - JSDoc中如何指定一个对象数组作为参数或返回值?

在JSDoc中,如果你有一个特定类型的数组(例如字符串数组),我能找到的最好的文档显示使用以下内容:/***@param{Array.}myStringsAllmyawesomestrings*/functionblah(myStrings){//stuffhere...}您将如何替换下面的问号来指定一个对象数组?/***@param{???????}myObjectsAllofmyequallyawesomeobjects*/functionblah(myObjects){//stuffhere...} 最佳答案 您应该更具体地说

javascript - JSDoc中如何指定一个对象数组作为参数或返回值?

在JSDoc中,如果你有一个特定类型的数组(例如字符串数组),我能找到的最好的文档显示使用以下内容:/***@param{Array.}myStringsAllmyawesomestrings*/functionblah(myStrings){//stuffhere...}您将如何替换下面的问号来指定一个对象数组?/***@param{???????}myObjectsAllofmyequallyawesomeobjects*/functionblah(myObjects){//stuffhere...} 最佳答案 您应该更具体地说

linux shell 将可变参数附加到命令

我正在尝试获取一个bash脚本,为给定的参数生成JSDoc./jsdoc.shfile.jsanother.jsmaybe-a-third.js我卡在了如何将未知数量的参数传递给下一个shell命令。(另外,不知道如何检查参数是否存在,只有在不存在时才if[-z...])此代码最多适用于两个参数,但显然不是正确的方法......#!/bin/bash#wouldliketoknowhowtodopositivecheckif[-z"$1"]thenechonoparamelsed=$PWDcd~/projects/jsdoc-toolkit/#thisbitisobviouslynot