Our training paths
Grow your skills
You’ll get our FREE Video Series & special offers on upcoming training events along with notifications on our latest blog posts.
Valid email required.
Submit failed. Try again or message us directly at email@example.com.
Check your email for confirmation.
As you know if you read my blog, I have been building a set of new utility packages so I can start developing an application server I need for a new project. I am brand new to Go and the Mac OS. Needless to say it has been one hell of an education over the past month. But I don’t miss Windows or C# at all.
I made some progress in my coding and wanted to build documentation for the code. I have been using the documentation viewer in LiteIDE and I was hoping to integrate my documentation in there was well. I was really surprised to see see that LiteIDE already had my packages listed inside of their integrated Godoc viewer. So it then begged the question. How is that working?After some digging around I found this local HTML file. If you have LiteIDE installed you can copy the following url into your browser.file:///Applications/LiteIDE.app/Contents/Resources/golangdoc/about.htmlThis is what it shows
There are 3 elements in play when writing your documentation. You have header sections, standard text and highlighted text.At the very top of your code file add the following using the // comment operation or something similar. Obviously you want to give yourself the credit for your work, LOL.// Copyright 2022 Ardan Studios. All rights reserved.// Use of this source code is governed by a BSD-style// license that can be found in the LICENSE file.Then add a block comment operator and we can start. Make sure the package code statement is exactly after the closing comment operator. There can not be no blank lines between the two.
You can see the same documentation that is being given to you locally is now published on the GoDoc website with your own reuseable url:
Copyright 2022 Ardan Studios. All rights reserved.<br />Use of this source code is governed by a BSD-style license that can be found in the LICENSE handle.Ardan Studios<br />12973 SW 112 ST, Suite 153<br />Miami, FL 33186<br />firstname.lastname@example.org<br />Click To View Documentation
Now people have access to the documentation I write on the web as well. I don’t need to copy and paste the documentation into the Readme Markdown file, just provide a link. All the documentation is in one place and formatted cleanly and consistently.As always, I hope this helps you in some small way and your documentation draws people to your work.
We have taught Go to thousands of developers all around the world since 2014. There is no other company that has been doing it longer and our material has proven to help jump start developers 6 to 12 months ahead of their knowledge of Go. We know what knowledge developers need in order to be productive and efficient when writing software in Go.
Our classes are perfect for both experienced and beginning engineers. We start every class from the beginning and get very detailed about the internals, mechanics, specification, guidelines, best practices and design philosophies. We cover a lot about "if performance matters" with a focus on mechanical sympathy, data oriented design, decoupling and writing production software.
Interested in Ultimate Go Corporate Training and special pricing?
Our courses have been designed from training over 4,000 engineers since 2013 and they go beyond just being a language course. Our goal is to challenge every student to think about what they are doing and why.
Please fill out the form below and we'll get back to you soon.
Check your email for confirmation of your sent message. We'll get back to you shortly.
Ardan Labs Copyrights © 2022