TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Swift API Design Guidelines

74 pointsby rayshanover 9 years ago

3 comments

sdegutisover 9 years ago
It's really clever how they have an official variation of Markdown as the official comment documentation format.
cballardover 9 years ago
To help with documentation, install VVDocumenter: <a href="https:&#x2F;&#x2F;github.com&#x2F;onevcat&#x2F;VVDocumenter-Xcode" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;onevcat&#x2F;VVDocumenter-Xcode</a><p>I&#x27;ve changed my trigger from &quot;&#x2F;&#x2F;&#x2F;&quot; to &quot;&#x2F;&#x2F;&#x2F;&#x2F;&quot; so that I can write &quot;&#x2F;&#x2F;&#x2F;&quot; comments manually if I want to.<p>-----<p>Some things I might add:<p>- If possible, use a protocol as the base for all functionality. Generally, this is named &quot;FooType&quot;.<p>- If you provide a &quot;FooType&quot;, provide a type-erased &quot;AnyFoo&quot; as well.
coinover 9 years ago
This website renders pretty crappy on an iPad.