Markdown in Xcode 12.5.1

Question

Created Aug ’21

Replies 1

Boosts 0

Views 1.3k

Participants 2

I'm trying to document my code using the Markdown, but it doesn't matter what I do, I am not seeing what I've typed show up when I ctrl-click a function and left click Show Quick Help.

Quick Help shows the parameters of the function, but it does not show the function description I typed or the description for the parameters that I typed.

Screen Shot 2021-08-07 at 1.52.09 AM.png

Is there something I am doing wrong or I've not set within Xcode?

I went through the preferences and didn't see anything that appeared to affect displaying of Markdown.

Answered by robnotyou in 684017022

Put the comment above the function declaration!

/// this is just an example of markdown.
///
/// - Parameters:
///     - someString: A simple string.
///     - someInteger: A simple integer
func myFunction(someString: String, someInteger: Int) {

Boost

Answer 1

robnotyou OP

Aug ’21

Accepted Answer

Put the comment above the function declaration!

/// this is just an example of markdown.
///
/// - Parameters:
///     - someString: A simple string.
///     - someInteger: A simple integer
func myFunction(someString: String, someInteger: Int) {

1