编辑:从技术上讲，这是一个由两部分组成的问题。我选择了涵盖一般问题的最佳答案，并链接到处理特定问题的答案。使用jsdoc记录匿名对象和函数的最佳方式是什么？/***@class{Page}PageClassspecification*/varPage=function(){/***Getapagefromtheserver*@param{PageRequest}pageRequestInfoonthepageyouwanttorequest*@param{function}callbackFunctionexecutedwhenpageisretrieved*/this.getPage
编辑:从技术上讲，这是一个由两部分组成的问题。我选择了涵盖一般问题的最佳答案，并链接到处理特定问题的答案。使用jsdoc记录匿名对象和函数的最佳方式是什么？/***@class{Page}PageClassspecification*/varPage=function(){/***Getapagefromtheserver*@param{PageRequest}pageRequestInfoonthepageyouwanttorequest*@param{function}callbackFunctionexecutedwhenpageisretrieved*/this.getPage
在JSDoc中，如果你有一个特定类型的数组(例如字符串数组)，我能找到的最好的文档显示使用以下内容:/***@param{Array.}myStringsAllmyawesomestrings*/functionblah(myStrings){//stuffhere...}您将如何替换下面的问号来指定一个对象数组？/***@param{???????}myObjectsAllofmyequallyawesomeobjects*/functionblah(myObjects){//stuffhere...} 最佳答案 您应该更具体地说
在JSDoc中，如果你有一个特定类型的数组(例如字符串数组)，我能找到的最好的文档显示使用以下内容:/***@param{Array.}myStringsAllmyawesomestrings*/functionblah(myStrings){//stuffhere...}您将如何替换下面的问号来指定一个对象数组？/***@param{???????}myObjectsAllofmyequallyawesomeobjects*/functionblah(myObjects){//stuffhere...} 最佳答案 您应该更具体地说
我知道Golang支持通过以函数名称(拼写为“func”)开头的单行注释来记录函数。然而，有一个令人作呕的副作用:有多个单行注释不会产生一个用换行符分隔每行文本的GoDoc这里有一张图片来说明:这是函数及其文档://GetFunctionNamegetsfunctionname//Parameters://-`i`:Function//**NOTE**thisfuncfailsif`i`isavariablesettoafunc//(they'recalled"anonymousfunctions"inJavaScript)funcGetFunctionName(iinterface{
我知道Golang支持通过以函数名称(拼写为“func”)开头的单行注释来记录函数。然而，有一个令人作呕的副作用:有多个单行注释不会产生一个用换行符分隔每行文本的GoDoc这里有一张图片来说明:这是函数及其文档://GetFunctionNamegetsfunctionname//Parameters://-`i`:Function//**NOTE**thisfuncfailsif`i`isavariablesettoafunc//(they'recalled"anonymousfunctions"inJavaScript)funcGetFunctionName(iinterface{
我想使用godoc生成的文档为我创建的项目静态提供(在AppEngine上)。我看到godoc启动了一个服务器，显然包文档都是动态生成的。但是是否有将文档保存到文件系统的解决方法，或者我还有哪些其他选择？ 最佳答案 如果您使用的是GitHub，那么已经有一个相当不错的项目:http://gopkgdoc.appspot.com/文档位于页面底部。它是开源的，只需稍加努力，您就可以使用它从非GitHub服务生成文档。 关于documentation-导出Go文档以静态提供的任何技巧？，我们
我想使用godoc生成的文档为我创建的项目静态提供(在AppEngine上)。我看到godoc启动了一个服务器，显然包文档都是动态生成的。但是是否有将文档保存到文件系统的解决方法，或者我还有哪些其他选择？ 最佳答案 如果您使用的是GitHub，那么已经有一个相当不错的项目:http://gopkgdoc.appspot.com/文档位于页面底部。它是开源的，只需稍加努力，您就可以使用它从非GitHub服务生成文档。 关于documentation-导出Go文档以静态提供的任何技巧？，我们
我用Go实现了一个典型的RESTAPI库。但是由于端点的数量和不同的数据结构，端点之间几乎没有共享的数据结构，项目的GoDoc非常困惑:它现在的结构方式使得很难看到实际函数返回的内容，需要大量滚动文档才能找到与数据相关的结构。端点都是API结构的一部分，因为它们可以在API调用之间共享身份验证状态，这导致它们全部列在GW2Api结构下方，而不是它们关联的数据结构。除了GoDoc之外，还有什么好的方法可以让库API更清晰吗？向函数调用添加注释？ 最佳答案 我认为很好的一个api包的例子是github包装器:https://godoc.
我用Go实现了一个典型的RESTAPI库。但是由于端点的数量和不同的数据结构，端点之间几乎没有共享的数据结构，项目的GoDoc非常困惑:它现在的结构方式使得很难看到实际函数返回的内容，需要大量滚动文档才能找到与数据相关的结构。端点都是API结构的一部分，因为它们可以在API调用之间共享身份验证状态，这导致它们全部列在GW2Api结构下方，而不是它们关联的数据结构。除了GoDoc之外，还有什么好的方法可以让库API更清晰吗？向函数调用添加注释？ 最佳答案 我认为很好的一个api包的例子是github包装器:https://godoc.
