Comments (4)
No, the external name is a part of method name, and the local parameter should be used. You can see the quick help of Apple's API to confirm it, they are using the local name.
from vvdocumenter-xcode.
Interesting. I can see that you would want to copy the way Apple does things but I can't see why the external documentation of a method would refer to an internal parameter name rather than the external parameter name, given that it is the external name that the user of the method would see. The person calling the method isn't (or shouldn't be) concerned with how the variable is named inside the method.
from vvdocumenter-xcode.
It looks like Apple are inconsistent in this matter...
from vvdocumenter-xcode.
As I said, an external param name will be used as the method name. It IS a part of your method name in fact, instead of the param name. The navigation bar is showing the method name while the quick help will show the internal name.
Think about what to show if a func is defined with a _
:
func hello(_ firstName: String, _ lastName: String)
There must be something to refer as the documentation, and the method name would be ok as hello(_:. _:)
from vvdocumenter-xcode.
Related Issues (20)
- Thank you!
- Xcode 8 可以用吗??
- 刚看了readme,感谢喵神,VVDocumenter
- 谢谢你,喵神,虽然这个插件可能再也用不到了。。。
- Thanks and hard to say goodbye
- It's alive thro all my code life. Bye and thanks.
- 谢谢~
- 被apple采纳,可谓之极矣.更提高了喵神的高度 :)
- 刚通读完Swifter 100Tip,是本好书,少有的干货。还有差点略过你的“后记”,因为不是“剧透党”
- Not working Xcode 8.3.2 HOT 1
- 你好,《Readme 》中的 Alcatraz
- 谢谢,虽然用不到了
- Xcode 8.3.2 无法使用了 HOT 1
- Thank you! 谢谢
- Good Bye ,Thank you HOT 1
- 再见,感谢喵神!~
- 感谢喵大!再见!VVDocumenter
- Thanks you . You are my God.
- Not working with Xcode 9.1 HOT 1
- New Life for VVDocumenter-Xcode :)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from vvdocumenter-xcode.