Função description

description(parameter) devolve o texto de descrição da definição parameter no idioma atual.

parameter pode ser uma variável, função ou unidade incorporada ou definida pelo utilizador.

Sintaxe¶

Se parameter for uma função, constante ou unidade incorporada, description() devolve a descrição incorporada.

Funções, constantes e unidades incorporadas

Se parameter for uma função, variável ou unidade definida pelo utilizador, description() devolve a descrição definida pelo utilizador.

Variáveis e funções definidas pelo utilizador

Se a descrição definida pelo utilizador tiver várias linhas, description() devolve-a como uma cadeia de uma só linha.

Descrição de várias linhas devolvida numa só linha

Se a descrição definida pelo utilizador não estiver definida, description() devolve uma cadeia vazia ou o valor zero.

description() sem descrição definida pelo utilizador

Para saber mais sobre como documentar um documento com descrições, consulte Descrições.

Esta página baseia-se num artigo da antiga wiki, escrito por Davide Carpi.