我正在尝试使用YUIDoc为JavaScript方法编写一些文档。看起来像:/**ReturnsaninstanceofclassName@methodgetInstance@param{string}classNametheoftheclassusedtocreatetheinstance@param{Object}optionstheseareoptionsusedtocreatetheinstance**/functiongetInstance(className,options){.....}现在，选项对象可以有多个参数，如options.id、options.single等。
假设我有一些对象，使用jsdoc3评论它的方法是什么？/***Testobject*@namespacetest*/vartest={/***Somedefaults*@memberOftest*/defaults:{'test1':1,'test2':2},/***Somthingelse*@memberOftest*/deep:{/***Someoption*@memberOf{test.deep}*/option:{},/***Somemethod*@memberOftest.deep*/method:{},/***Someoption*@memberOf{test.deep.e
有没有一种方法可以避免为@property和@param键入两行单独的内容，如示例所示，在构造函数中参数和属性的名称相同。/***Classforrepresentingapointin2Dspace.*@property{number}xThexcoordinateofthispoint.*@property{number}yTheycoordinateofthispoint.*@constructor*@param{number}xThexcoordinateofthispoint.*@param{number}yTheycoordinateofthispoint.*@return
给定一个带有返回类的工厂的Angular应用程序，如下所示:angular.module('fooApp').factory('User',function(){functionUser(name){this.name=name;}User.prototype.greet=function(){return"Howdy,"+this.name;}returnUser;});使用ngdoc(jsdocAngular使用的特殊风格)，如何在不将其定义为方法的情况下记录初始化程序？现在，这是我尝试过的:/***@ngdocservice*@namefooApp.User*@descripti
这类似于question30360391.我想表达的是，函数的参数是一个普通的JS对象，它可以具有任意属性(未知)名称，但所有属性本身都是具有固定属性的对象。一个例子:函数就是这样/***@param{Descriptor}desc*/functionfoo(desc){//...}一个典型的desc看起来像desc={unknownEntity1:{priority:5;writable:false;},unknownEntity2:{priority:42;writable:true;},unknownEntity3:{priority:9;writable:false;}}我已经
我想为这段代码放置我的标记针:varmap=newGMap2(document.getElementById("map-canvas"));map.addControl(newGLargeMapControl());map.addControl(newGMapTypeControl());map.setCenter(newGLatLng(,),6);varpoint=newGLatLng(,);varmarker=createMarker(point,'Welcome:SecondInfoWindowwithanimage')map.addOverlay(marker);functio
ESDOC似乎只针对ES6类样式。有没有办法记录一个普通的对象，比如:/***???*/varFoo={/***???*/info:true};exportdefaultFoo;甚至在使用ES6类样式时，如何记录静态属性，例如:classBar{}/***???*/Bar.info=true;exportdefaultBar; 最佳答案 简答。没有。ESDOC专门用于记录ES6类。它的名字是正确的。来自FAQ:ESDocsupportsES2015andlater如果您需要记录ES6+和常规(原型(prototype))类的混合，J
我正在使用godocs来记录我用go/golang编写的API，我正在使用godocs来记录它，因为我生成了整个main.go文件的HTML页面，其中包含用于创建我的API的所有函数。但是，我不想显示有关我的所有辅助函数的信息，我只想显示有关文件中某些函数的标题信息。有没有办法只允许文件中的某些函数成为文档的一部分，或者我是否必须为我的所有辅助函数创建另一个文件？现在我正在本地端口8000上测试它:godoc-http=:8000 最佳答案 命令godoc及其堂兄弟godoc的默认行为，显示导出声明的包文档.奇怪的是，我没有找到一个
我正在尝试使用Godoc为项目生成一些基本文档，但每次我这样做时，它也会为所有Go包添加文档。有没有办法控制它并让它只为我的项目代码生成文档？我正在使用:godoc-http=:6060 最佳答案 Isthereawaytocontrolthisandhaveitonlygeneratedocumentationformyprojectcode?没有。 关于Godoc:将文档限制为项目(不是依赖项)，我们在StackOverflow上找到一个类似的问题： ht
新的godoc有一些很好的特性，比如调用者列表等。不管怎样，我在运行它时遇到了问题，比如:➜~GOPATHgit:(master)✗lssrc/github.com/coreos/etcd/CHANGELOGDCODocumentationREADME.mdbenchbuildcontriberrorfixturesgo_version.gohttpmain.gomodscriptsstoretestsCONTRIBUTING.mdDockerfileLICENSEVagrantfilebinconfigdiscoveryetcdfoogopathlogmetricspkgserver
