Does Swift have documentation generation support?

前端 未结 12 1448
伪装坚强ぢ
伪装坚强ぢ 2020-11-28 00:15

Many languages support documentation comments to allow a generator (like javadoc or doxygen) to generate code documentation by parsing that sam

12条回答
  •  抹茶落季
    2020-11-28 00:31

    Yes. Base common (I made snippets for it with Obj-C equivalent)

    Objective-C:

    /**
     @brief <#Short description - what it is doing#>
    
     @discussion <#Description#>
    
     @param  <#paramName#> <#Description#>.
    
     @return <#dataType#> <#Description#>.
     */
    

    Swift

    /**
    <#Short inline description - what it is doing#>
    
    <#Description#>
    
    :param:  <#paramName#> <#Description#>.
    
    :returns: <#dataType#> <#Description#>.
    */
    

提交回复
热议问题