Learn more Swift and SwiftUI with my courses at seanallen.teachable.com
@Sachka
Ай бұрын
hey, i'm an ai engineer, i'm looking forward to purchase a vision course where you would showcase how to talk to a 3d asset, i mean just create the 3d sphere of siri a version that follows you around would be enough, btw keep the good work
@danuff
Ай бұрын
OMG THANK YOU. Never knew what DocC actually did until now. I'll be busy for the next few hours. 🙂
@seanallen
Ай бұрын
Happy to help!
@darylewalker6862
Ай бұрын
Thanks for telling me about the side-panel documentation preview!
@seanallen
Ай бұрын
It's pretty cool
@s81n
Ай бұрын
I get some heat sometimes at work for saying "There's no such thing as self-documenting code" but I stand by it. Your code may say what you're doing, but it can't tell why you're doing it and the why is the important part the comments need to cover. That being said I also don't accept uncommented pull requests. Too many people need to touch our code years from now, those comments are important.
@seanallen
Ай бұрын
I agree. The "why" is SO important.
@kennvillegas2014
Ай бұрын
This is really interesting. Having a strong background in ObjC\Cocoa I am very used to this Markdown style The ONE thing that I will add is that you can ALSO do this with a foldable block-comments just starting with standard /** */ delimiters
@marceljaeger
Ай бұрын
Nice video, DocC is amazing! While you are in the developing process of an app, you might know every function. But after a few weeks break, it`s so hard and annoying to dive in the codebase again, if the project is big and you haven't write a documentation. 😵
@seanallen
Ай бұрын
Exactly :)
@TE_-.-
Ай бұрын
Just a quick question, can you collapse these comments in the code base or hide them in some other way? Yes, it's good to see them, but for me it's too confusing when I see so many lines of comments.
@seanallen
Ай бұрын
I'm not sure, but I agree with your sentiment. That's why I changed the color of my comments/documentations in Xcode to be a light grey so it's not prominent. My code is colorful so that's what sticks out while the comments kind of blend into the background. That's my solution for this at least.
@roygalaasen
Ай бұрын
I posted a link to a helpful article, but it seems to have been removed. I will not repost the link, but wanted to add a comment from other posters here that you can make foldable comments with the block comment tag /** */
@seanallen
Ай бұрын
@@roygalaasen Hey Roy, I didn't remove the comment (I never do that). Not sure what happend.
@roygalaasen
Ай бұрын
@@seanallen Maybe it was filtered out automatically by Google or something as all I posted was a link to an article on Medium with no more context other than it was clear by the url where the link would go plus the topic. I was going to add to that link but it was gone. These things happens, by saying the comment was removed, I didn’t mean necessarily that _you_ were the one removing it. It actually happens once in a blue moon, could just be a KZitem bug as well.
@shashikumar740
28 күн бұрын
Helpful information 🙌
@seanallen
27 күн бұрын
Glad it was helpful!
@muncho404
Ай бұрын
Thanks for sharing Sean
@seanallen
Ай бұрын
You bet!
@arrwoodo
Ай бұрын
That was REALLY helpful! ThX!)
@seanallen
Ай бұрын
Glad it helped!
@JasonMitchellAZ
Ай бұрын
I've been using doc comments some, but learned some more cool things I didn't know about. Also, you can use multi-line style commenting for doc comments, too - i.e. /** and close with */
@seanallen
Ай бұрын
Thanks for sharing that! So many cool tricks with this.
@iLoveAppl3947
Ай бұрын
nice one chief
@austnsauce2543
Ай бұрын
Wow I just wrote down "learn ios documentation" on my todo list for my app and this video shows up today. Thanks!
@seanallen
Ай бұрын
👀
@dre5671
Ай бұрын
Pro Tip: Ask Claude or GPT to add documentation for your code. It’s usually pretty great right away. Extra pro tip, build your own gpt to use things like important/tip/warning/etc, also back ticks to improve your documentation Didn’t know about the back ticks and the important bubbles till now! Sweet stuff 🙏🏼
@seanallen
Ай бұрын
I'm a big fan of those important bubbles.
@RyanPhung725
Ай бұрын
Thanks for the video! If you have a lot to document for a function, the inline documentation would get very large. Is there a way to bring this to a new file or hide it some way? Thank you!
@kris_torres
Ай бұрын
Nice vid on DocC. I didn’t know that you can do double ticks for the code links. 🙂 Quick question: Do you recommend also commenting the private structs, methods, et al., or only the ones that are “public”?
@seanallen
Ай бұрын
Based on this question, I assume you're building a library. In that case, these are for two different "users". The public functions or for other developers that use your library, so I'd say that's a must. All the private functions are for you and your internal team. So if you want good documentation for you and your internal team, then I would say yes. If that's not important to you, then don't.
@fg8520
Ай бұрын
please tutorial on airdrop usage in your app, great video as always
@DaveJacobseniOS
Ай бұрын
Fantastic walkthrough! I just joined a new company that uses DocC and I've never dealt with it before so this is very timely 👌
@bored7743
Ай бұрын
Kudos for learning this shit. Couldn’t do it. Bored me to death
@samtr4439
Ай бұрын
Thanks Sean.
@seanallen
Ай бұрын
Any time
@bryceellis112
Ай бұрын
This is was a very impactful video. Thanks for sharing. When you include code snippets (6:18) could you put them at the end of your file? Or does it make most sense to keep it near the function
@BehindTheFilm
2 ай бұрын
So good 🤩 Thanks for sharing!
@seanallen
2 ай бұрын
I’m a big fan of this. Happy to share!
@ianfrye8988
Ай бұрын
Great video my friend!
@seanallen
Ай бұрын
Glad you enjoyed it!
@KuisebGecko
Ай бұрын
Sean, you once apologised in a video for being 'anal', I for one appreciate your desire to make the code more readable. My code has grown to the extent where I would be spending more time on figuring out what my previous code did rather than spending that time to improve the app. I have taken a stab at DocC once but found myself wasting more time in trying to figure it all out; so thank you VERY MUCH for your videos on summarising these important tools. Like a previous poster said, your videos very often come out at EXACTLY the right time.😎👍
@vamsi3877
Ай бұрын
Awesome Sean 👏
@seanallen
Ай бұрын
Glad you enjoyed it
@nileshjdarji
Ай бұрын
Wow! This is wild. 👍
@seanallen
Ай бұрын
Pretty cool, right?
@Stricken174
Ай бұрын
Documentation is a great feature, i'm using from time to time to indicate some spicy stuff with warnings.
Пікірлер: 51