How to use Swift documentation comments

后端 未结 5 1358
你的背包
你的背包 2021-01-30 01:10

I have a few questions about Swift documentation comments:

  1. Is there a way to make a Related declarations section like some of the Apple documentation has? For e

5条回答
  •  抹茶落季
    2021-01-30 01:24

    Use the following notation for documentation comments.

    /**
     This method sum two double numbers and returns.
    
     Here is the discussion. This methods adds two double and return the optional Double.
    
    
     - parameter number1: First Double Number.
     - parameter number2: Second Double Number.
     - returns: The sum of two double numbers.
    
     # Notes: #
     1. Parameters must be **double** type
     2. Handle return type because it is optional.
    
     # Example #
    ```
     if let sum = self.add(number1: 23, number2: 34) {
      print(sum)
     }
     ```
    */
    
    
    func add(number1: Double, number2: Double) -> Double? {
        return number1 + number2
    }
    

提交回复
热议问题