Plantilya:docparam/doc

Hali sa Wiksyunaryo

Paggamit[baguhon]

{{docparam|parameter_name}}
{{docparam|parameter_name|additional_info}}

An plantilla na ini ginibo para mapasimple asin magin parareho an dokumentasyon kan mga parametro sa subpahina kan dokumentasyon kan plantilya. Pwede man ini gamiton sa mga pahina kan orolay, pahina kan mga paragamit, iba pa, pero dai ini pwedeng gamiton direkta sa diksyonaryo.

Tandaan, kun ika masabi sana kan parametro sa sarong diskusyon, {{para}} na sana an gamiton, bako na ining plantilla na ini.

Mga Parametro[baguhon]

Duwang posisyonal na daing ngaran na parametro an sinusuportahan:

  • |1= an ngaran kan parametro na idodokumento, dapat espisifiko, pero kun mayo, ini nakadefault sa "1"
  • |2= (opsyonal) mga dugang na impormasyon, arog kan "opsyonal", "kaipuhan", "kun bakong Ingles", etc.

Halimbawa[baguhon]

An listahan sa nakaaging seksyon, nakalista sa koda arog kan nasa ibaba:

* {{docparam|1}} an ngaran kan parametro na idodokumento, dapat espisifiko, pero kun mayo, ini nakadefault sa "1"
* {{docparam|2|'opsyonal''}} mga dugang na impormasyon, arog kan "opsyonal", "kaipuhan", "kun bakong Ingles", etc.

Pagirumdom[baguhon]

  1. Nin huli ta an plantillang ini nagtatao nin equal sign (=), an pag apod sa plantillang ini dai dapat susundan nin punctuation arog kan colon (:), hyphen (-) or dash ().