Typescript中的参数与选项_Typescript_Arguments_Parameter Passing_Documentation Generation

Typescript中的参数与选项

typescript

Typescript中的参数与选项,typescript,arguments,parameter-passing,documentation-generation,Typescript,Arguments,Parameter Passing,Documentation Generation,基于这个问题, 我想知道这是如何应用于Typescript的。我想做出一个决定，以便：预编译器/lint给出的提示将尽可能相关房间也将尽可能干净我现在发现的利弊： Typescript可以很好地处理可选参数，但依赖于参数的顺序和一长串参数并不是一件方便的事情使用选项对象很好，但需要为每个对象创建一个接口（？），据我所知，这会使代码过载，我不知道会生成哪种文档/提示在我看来，同样的情况仍然适用于打字脚本。不要依赖IDE来提示代码的功能。最好让代码告诉您它的功能参数越多，代码的可读

基于这个问题,

我想知道这是如何应用于Typescript的。我想做出一个决定，以便：

预编译器/lint给出的提示将尽可能相关
房间也将尽可能干净

我现在发现的利弊：

Typescript可以很好地处理可选参数，但依赖于参数的顺序和一长串参数并不是一件方便的事情
使用
```
选项
```
对象很好，但需要为每个对象创建一个接口（？），据我所知，这会使代码过载，我不知道会生成哪种文档/提示

参数越多，代码的可读性就越差

sendMsg("Poem", "I sing of brooks, of blossoms, birds and bowers.", new Date(2015, 9, 20));

function sendMsg(title: string, body: string, dateToSend = new Date())

太多的参数会使更改变得困难并增加出错的机会

datetosendreach

function sendMsg(title: string, body: string, dateToSendAgain: Date, dateToSend = new Date())

// now creates a message with dateToSendAgain = new Date(2015, 9, 20)
// and dateToSend = new Date()
sendMsg("Poem", "I sing of brooks, of blossoms, birds and bowers.", new Date(2015, 9, 20));

dateToSend

新日期（2015,9,20）

new Date（）

dateToSend

新日期（2015,9,20）

改用具有属性的对象

sendMsg({
    title: "Poem", 
    body: "I sing of brooks, of blossoms, birds and bowers.", 
    dateToSend: new Date(2015, 9, 20)
});

datetosendreach

sendMsg({
    title: "Poem", 
    body: "I sing of brooks, of blossoms, birds and bowers.", 
    dateToSend: new Date(2015, 9, 20),
    dateToSendAgain: new Date(2015, 10, 20)
});

建议

如果没有太多参数，可以使用多个参数，并且通过查看函数名可以理解每个参数的含义
否则，请使用具有属性的对象
如果可读的话，把这两个混合在一起是可以的

对象属性文档

/**
 * The options for sendMsg
 */
interface SendMsgOptions {
    /**
    * The title of the message
    */
    title: string;
    // etc...
}

function sendMsg(options: SendMsgOptions)

@param{string}employee.name-员工的名称。

function sendMsg(options: SendMsgOptions)