/ / Ako dokumentovať označenie argumentov a nie názov parametra funkcie Swift v XCode? - rýchle, xcode, markdown, dokumentácia

Ako dokumentovať označenie argumentov a nie názov parametra funkcie Swift v XCode? - rýchle, xcode, markdown, dokumentácia

Viem, ako dokumentovať názov parametra funkcie, ako je:

/**
- parameters:
- param: the parameter
*/
func myFunc(param: Int) {...}

ale nemôžem dokumentovať štítok s argumentmi (s názvom parametra alebo bez neho):

/**
- parameters:
- label: the label
- param: the parameter
*/
func myFunc(label param: Int) {...}

Koniec koncov, dokumentácia štítku je dôležitejšia ako názov parametra, pretože to je to, čo sa používa pri volaniach funkcií.

Poznámka: Nedokázal som nájsť trik v dokumentácii spoločnosti Apple, alebo mi niečo chýbalo?

odpovede:

1 pre odpoveď č. 1

vy nemôže priamo odkazovať na názov argumentu v dokumentácii funkcie.

Ako riešenie môžete spomenúť štítok v popise parametra, napríklad:

/**
- parameters:
- param: (argument label: `label`) the parameter
*/
func myFunc(label param: Int) {...}

Použitím spätných kliešťov sa zmes dobre spája so samotným parametrom:

príklad funkčnej dokumentácie