有谁知道在哪里可以找到 SS2.0 JSDOC 定义库?
Does anyone know where to find a SS2.0 JSDOC definition library?
有人知道或有我可以用于 SS2.0 的 JSDOC 定义库吗??
我目前拥有的 SS1.0 看起来像下面的那个,我用它插入我的 IDE 并获得自动完成功能。
/** * Loads an existing saved search. The saved search could have been created using the UI, or created using nlapiCreateSearch(type, filters, columns) in conjunction with nlobjSearch.saveSearch(title, scriptId).
*<br>API Governance: 5
* @param {String} recType [optional] - The record internal ID of the record type you are searching (for example, customer|lead|prospect|partner|vendor|contact). This parameter is case-insensitive.
* @param {String} searchId - The internal ID or script ID of the saved search. The script ID of the saved search is required, regardless of whether you specify the search type. If you do not specify the search type, you must set type to null and then set the script/search ID.
* @returns {nlobjSearch} nlobjSearch
* @since 2012.1 */
function nlapiLoadSearch(recType, searchId) { };
不是真正的技术问题,但对每个人都会派上用场。
SS2 的工作方式基本上是你的运气不好。
考虑
define(['N/search'], function(bob){
var srch = bob.load({id:'customsearch_my_search'});
}
什么是鲍勃?您的 IDE 必须非常聪明才能知道 bob 是搜索名称空间的一部分。这当然是可行的,但不太可能使用一个简单的可下载文件,您只需将其插入 IDE。如果您只是使用 'search' 可能会使事情更有可能起作用,但现在您已经用完了一个无法在其他地方使用的非常通用的名称。
此外,如果 IDE 可以确定 'bob' 现在是什么,那么您的参数是无序散列,因此位置 @params 不再起作用。
打字稿可能有帮助。我一直在 https://github.com/BKnights/KotN-Netsuite 维护 SS1 的 Typescript 定义文件。当我开始使用 SS2.0 做更多事情时,我可能会为此做同样的事情。那么你的IDE会有更多的机会:
define(['N/search'], function(bob:NSearch){...
所以你的 Typescript 感知 IDE 可以使用它来完成成员,至少你会对类型进行编译时检查
你可以考虑我做的,不需要下载其他插件。
如果您有 SS2.0 API 的副本,然后使用“@param”和“@type”JSDOC 标签,您将能够启用代码辅助。
然后,每次输入 then 'CTRL' + 'SPACE" 时都会有提示。
除此之外,您的 IDE 还将提供每个功能的说明。
这就是你要做的。
- 在您的 NetSuite 帐户上,下载 SuiteScript 2.0 JavaScript 文件。您可以通过导航到 >Documents>Files>SuiteScripts> 来完成此操作。然后在屏幕的右侧,您应该会看到 "SuiteScript 2.0 API" 和 "SuiteSCript 1.0 API" 的链接。点击下载SS2.0。
- 在 Eclipse IDE 上,为 SS2.0 创建一个新的 JavaScript 项目或将其包含在现有项目中。
- 接下来在您正在处理的项目上,右键单击然后 select“属性”。在 >JavaScript>Include Path 下,然后在“Projects”子选项卡中,添加包含 SS2.0 APIs 的项目。
- 您现在将获得 SS2.0 的对象文字 API 的代码帮助。这些是 'N/log' 和“N'util”模块。
接下来要启用 SS2.0 的对象构造函数 API 的代码辅助,如 'N/record' 和 'N/search' 模块,我们应该添加“@param " 每个函数声明上的 JSDoc 标记。
因此,如果我们要在我们的脚本中使用 'N/record'、'N/search' 和 'N/error' 模块,我们应该在函数声明之前有以下示例注释。但请注意,它应该与“{[VALUE HERE]}”标签内的值和模块名称相匹配。还有注释部分和函数声明中的变量名。
/**
* Do something.
*
* @param {record} objRec
* @param {search} objSearch
* @param {error} objError
*
*/
function doSomething(objRec, objSearch, objError)
{
//CODE HERE
}
您也可以使用“@type”作为变量声明。下面是示例代码。
/**
* Do something.
*
*/
function doSomething()
{
/*** @type record**/
var recCustomerRefund = record.create(
{
type : 'customerrefund',
isDynamic : true
});
}
有人知道或有我可以用于 SS2.0 的 JSDOC 定义库吗??
我目前拥有的 SS1.0 看起来像下面的那个,我用它插入我的 IDE 并获得自动完成功能。
/** * Loads an existing saved search. The saved search could have been created using the UI, or created using nlapiCreateSearch(type, filters, columns) in conjunction with nlobjSearch.saveSearch(title, scriptId).
*<br>API Governance: 5
* @param {String} recType [optional] - The record internal ID of the record type you are searching (for example, customer|lead|prospect|partner|vendor|contact). This parameter is case-insensitive.
* @param {String} searchId - The internal ID or script ID of the saved search. The script ID of the saved search is required, regardless of whether you specify the search type. If you do not specify the search type, you must set type to null and then set the script/search ID.
* @returns {nlobjSearch} nlobjSearch
* @since 2012.1 */
function nlapiLoadSearch(recType, searchId) { };
不是真正的技术问题,但对每个人都会派上用场。
SS2 的工作方式基本上是你的运气不好。
考虑
define(['N/search'], function(bob){
var srch = bob.load({id:'customsearch_my_search'});
}
什么是鲍勃?您的 IDE 必须非常聪明才能知道 bob 是搜索名称空间的一部分。这当然是可行的,但不太可能使用一个简单的可下载文件,您只需将其插入 IDE。如果您只是使用 'search' 可能会使事情更有可能起作用,但现在您已经用完了一个无法在其他地方使用的非常通用的名称。
此外,如果 IDE 可以确定 'bob' 现在是什么,那么您的参数是无序散列,因此位置 @params 不再起作用。
打字稿可能有帮助。我一直在 https://github.com/BKnights/KotN-Netsuite 维护 SS1 的 Typescript 定义文件。当我开始使用 SS2.0 做更多事情时,我可能会为此做同样的事情。那么你的IDE会有更多的机会:
define(['N/search'], function(bob:NSearch){...
所以你的 Typescript 感知 IDE 可以使用它来完成成员,至少你会对类型进行编译时检查
你可以考虑我做的,不需要下载其他插件。
如果您有 SS2.0 API 的副本,然后使用“@param”和“@type”JSDOC 标签,您将能够启用代码辅助。
然后,每次输入 then 'CTRL' + 'SPACE" 时都会有提示。
除此之外,您的 IDE 还将提供每个功能的说明。
这就是你要做的。
- 在您的 NetSuite 帐户上,下载 SuiteScript 2.0 JavaScript 文件。您可以通过导航到 >Documents>Files>SuiteScripts> 来完成此操作。然后在屏幕的右侧,您应该会看到 "SuiteScript 2.0 API" 和 "SuiteSCript 1.0 API" 的链接。点击下载SS2.0。
- 在 Eclipse IDE 上,为 SS2.0 创建一个新的 JavaScript 项目或将其包含在现有项目中。
- 接下来在您正在处理的项目上,右键单击然后 select“属性”。在 >JavaScript>Include Path 下,然后在“Projects”子选项卡中,添加包含 SS2.0 APIs 的项目。
- 您现在将获得 SS2.0 的对象文字 API 的代码帮助。这些是 'N/log' 和“N'util”模块。
接下来要启用 SS2.0 的对象构造函数 API 的代码辅助,如 'N/record' 和 'N/search' 模块,我们应该添加“@param " 每个函数声明上的 JSDoc 标记。
因此,如果我们要在我们的脚本中使用 'N/record'、'N/search' 和 'N/error' 模块,我们应该在函数声明之前有以下示例注释。但请注意,它应该与“{[VALUE HERE]}”标签内的值和模块名称相匹配。还有注释部分和函数声明中的变量名。/** * Do something. * * @param {record} objRec * @param {search} objSearch * @param {error} objError * */ function doSomething(objRec, objSearch, objError) { //CODE HERE }
您也可以使用“@type”作为变量声明。下面是示例代码。/** * Do something. * */ function doSomething() { /*** @type record**/ var recCustomerRefund = record.create( { type : 'customerrefund', isDynamic : true }); }