标签: intellisense-documentati

为Intellisense的注释添加换行符

有没有人知道如何在摘要注释中插入换行符,以便在Intellisense文档中反映换行符?

为了澄清,假设代码文档..

/// <summary>
/// Some text documentation
///  - a line break - 
/// Some more documentation
/// </summary>
public void SomeMethod() { }
Run Code Online (Sandbox Code Playgroud)

因此,当使用此方法时,Intellisense提供了这样格式化的方法的摘要:

一些文字文件

更多文档

(注意 - 'para'标签不会创建空换行符 - 我已经尝试过了!)

.net intellisense intellisense-documentati

77
推荐指数
4
解决办法
3万
查看次数

Google Apps脚本自动生成的库文档

我目前正在开发Google Apps脚本库,该库基本上将电子表格视为数据库对象。

当前,该库具有两个相同的功能,例如

/**
* Opens and creates a query object for a spreadsheet with the given url.
*
* @param {String} the url of the spreadsheet
* @return {SpreadsheetQuery_} a spreadsheet query object for the given spreadsheet
*/
function openByUrl(url) {
    return new SpreadsheetQuery_(SpreadsheetApp.openByUrl(url));
}
Run Code Online (Sandbox Code Playgroud)

现在,对于这两个公共函数,生成的文档仅显示返回类型,而不显示参数或附带的说明。我假设这是一个Google问题,并没有真正打扰。

但是我的主要问题是,由于函数正在从私有函数实例化对象,因此如何获取自动文档以显示该对象上存在的方法。所有功能都将由对象提供,如果GAS可以在其上显示方法,那就太好了。

注意


这些方法都放在函数的原型上。例如。

SpreadsheetQuery_.prototype.from =函数(工作表){
    如果(_.isNumeric(sheet)){
        ....
}

谢谢。

documentation shared-libraries code-documentation intellisense-documentati google-apps-script

3
推荐指数
1
解决办法
1342
查看次数