<value> (JavaScript)

Especifica informações de documentação para get e set funções ECMAScript 3 Propriedades.

<value type="ValueType" integer="true|false" domElement="true|false" mayBeNull="true|false" elementType="ArrayElementType" elementInteger="true|false" elementDomElement="true|false" elementMayBeNull="true|false" locid="descriptionID">description</value>

Parâmetros

  • type
    Opcional.O tipo de dados da propriedade.O tipo pode ser um destes procedimentos:

    • Um tipo de linguagem do ECMAScript é como na especificação ECMAScript 5, Number e Object.

    • A DOM object, such as HTMLElement, Window, and Document.

    • Uma função de construtor de JavaScript.

  • integer
    Opcional.Se type é Number, especifica se a propriedade é um inteiro.Defina como true para indicar que a propriedade é um inteiro; Caso contrário, defina como false.Este atributo não é usado pelo Visual Studio para fornecer informações de IntelliSense.

  • domElement
    Opcional.Esse atributo é preterido; o type atributo tem precedência sobre este atributo.Este atributo especifica se a propriedade documentada é um elemento DOM.Defina como true para especificar que a propriedade é um elemento DOM; Caso contrário, defina como false.Se o type atributo não está definido e domElement é definido como true, IntelliSense trata a propriedade documentada como um HTMLElement ao executar a conclusão da instrução.

  • mayBeNull
    Opcional.Especifica se a propriedade documentada pode ser definida como null.Defina como true para indicar que a propriedade pode ser definida como null; Caso contrário, defina como false.O valor padrão é false.Este atributo não é usado pelo Visual Studio para fornecer informações de IntelliSense.

  • elementType
    Opcional.Se type é Array, este atributo especifica o tipo dos elementos na matriz.

  • elementInteger
    Opcional.Se type é Array e elementType é Number, este atributo especifica se os elementos da matriz são números inteiros.Defina como true para indicar que os elementos da matriz são inteiros; Caso contrário, defina como false.Este atributo não é usado pelo Visual Studio para fornecer informações de IntelliSense.

  • elementDomElement
    Opcional.Esse atributo é preterido; o elementType atributo tem precedência sobre este atributo.Se type é Array, este atributo especifica se os elementos da matriz são elementos DOM.Defina como true para especificar que os elementos são elementos DOM; Caso contrário, defina como false.Se o elementType atributo não está definido e elementDomElement é definido como true, IntelliSense trata cada elemento na matriz como uma HTMLElement ao executar a conclusão da instrução.

  • elementMayBeNull
    Opcional.Se type é Array, especifica se os elementos da matriz podem ser definidos como null.Defina como true para indicar que os elementos da matriz podem ser definidos como null; Caso contrário, defina como false.O valor padrão é false.Este atributo não é usado pelo Visual Studio para fornecer informações de IntelliSense.

  • locid
    Opcional.O identificador para informações sobre a propriedade de localização.O identificador é um membro ID ou ele corresponde do name valor em um pacote de mensagem definido pelos metadados OpenAjax do atributo.O tipo de identificador depende do formato especificado na <loc> (JavaScript) elemento.

  • description
    Opcional.Descrição da propriedade.

Comentários

Uso do ECMAScript 5 propriedades do <summary> (JavaScript) elemento.

Use o <value> elemento imediatamente antes do get ou set função.

Exemplo

O exemplo de código a seguir mostra como usar o <value> elemento em um get função.

    function Sys$CancelEventArgs$get_cancel() {
        /// <value type="Boolean" locid="P:J#Sys.CancelEventArgs.cancel"></value>
        if (arguments.length !== 0) throw Error.parameterCount();
        return this._cancel();
    }

Consulte também

Conceitos

Comentários de documentação XML (JavaScript)