Jump to content

header


Loading...
 Share

Recommended Posts

deram-me isto e disseram-me que eu tinha que fazer isso para o meu relatorio mas eu nao faço a minima ideia do que e isto olho para aquilo e nao percebo no que é que aquilo me pode ajudar xD

Exemplo de header de função

/**
* constroi_query - Constroi a query a efectuar
*
* Esta funcao usa os dados introduzidos pelo 
* utilizador para construir a respectiva query
*
* @param string $ordenar
* @return string $sql
* @author J
* @version 1.00
* @copyright Copyright (c)
*/

function constroi_query($ordenar){

…
…

}
Link to comment
Share on other sites

Isso não é um header, é um docblock. Um comentário que indica o que é que a função faz, que parâmetros aceita e o que devolve.

"Para desenhar um website, não tenho que saber distinguir server-side de client-side" - um membro do fórum que se auto-intitula webdesigner. Temo pelo futuro da web.

Link to comment
Share on other sites

Ah! LOL

Isso é documentação para o programador (o que escreveu a função e o seguinte, que vai ter que alterá-la (nem que seja o mesmo daqui a uns meses ...)).

No teu exemplo acima, o header da função constroi_query() explica o que a função faz, o que querem dizer os parametros e o resultado. Diz ainda quem escreveu a função.

Falta dizer como é que ela faz o que faz, e se há limites ou regras nos parametros / resultados. Por exemplo: não explicita o que acontece a constroi_query("")

Há sistemas de documentação que percorrem os ficheiros source à procura de comentários de documentação e criam a documentação automaticamente a partir daí. Não sei se usas algum sistema desses; mas, se usas, deves fazer o header de função de acordo com as regras do teu sistema.

What have you tried?

Não respondo a dúvidas por PM

A minha bola de cristal está para compor; deve ficar pronta para a semana.

Torna os teus tópicos mais atractivos e legíveis usando a tag CODE para colorir o código!

Link to comment
Share on other sites

humm obrigado x) agora ja sei para que serve xD

PS: desabafo (frustrated mode on)

é que eu e o meu colega caímos de paraquedas no estagio, gastamos 6€ todos os dias para vir para aqui, para não termos ajuda nenhuma e não se preocuparem minimamente connosco. a única coisa que ele nos disse foi para fazermos um site em php e mysql (o que não demos nas aulas ou seja temos que pesquisar na internet tudooooo) e ainda diz que não trabalhamos e que fazemos plagio e ainda manda indirectas (e algumas directas) para ver se trabalhamos mais ou coisa parecida....

peço desculpa pelo desabafo mas estou mesmo frustrado e desmotivado... (frustrated mode off) xD

Link to comment
Share on other sites

Boas,

Pelo que percebi quem vos deu esse trabalho deixou as indicações do que pretendia, através de comentários, e fez a primeira e última linha do trabalho.

Digo isto na boa, vocês estão assim  :wallbash:

Quando vos é dado um trabalho tentem perceber as ajudas/explicações que vos foram dadas. Podem não ser verbais e "amigas".

Link to comment
Share on other sites

é que eu e o meu colega caímos de paraquedas no estagio, gastamos 6€ todos os dias para vir para aqui, para não termos ajuda nenhuma e não se preocuparem minimamente connosco. a única coisa que ele nos disse foi para fazermos um site em php e mysql (o que não demos nas aulas ou seja temos que pesquisar na internet tudooooo) e ainda diz que não trabalhamos e que fazemos plagio e ainda manda indirectas (e algumas directas) para ver se trabalhamos mais ou coisa parecida....

O segredo é fazerem o trabalho de casa.

Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share

×
×
  • Create New...

Important Information

By using this site you accept our Terms of Use and Privacy Policy. We have placed cookies on your device to help make this website better. You can adjust your cookie settings, otherwise we'll assume you're okay to continue.