Clever Geek Handbook

Xcode Freelance Code Descriptions

For some methods, Xcode's code completion / sentence / autocomplete function displays descriptions:

the description is shown at the end of the code

When I create classes, functions, variables, and what not and do not provide a description, the description is not displayed:

custom function description ** not ** show

However, the Quick Help menu on the right side and when pressed alt+click

does the following:

description in quick menu works

I tried this "solution" but it didn't work. Are there any special characters that I need to include in the description?

Note

I am currently in Xcode 9 beta 1, but I also ran into this issue in Xcode 8.

Update

I'm glad to say it now works for me in Xcode 9 GM.

+3


source to share


1 answer


I think the reason is because there is no space after /// .
The right path must be

/// This is a description


In fact, if you add documentation for the function mentioned in the screenshot, comments yourself are added, where you can see that there is a space after ///. Which is the intact correct way to add comments / documentation.
After you click on the function call, a description is displayed.
The way Apple displays in autocomplete is what it does itself. You can use AppleDoc for this.

enter image description here

+1


source






More articles:


All Articles