As a professional game developer, you'll frequently find yourself working inside prefabs that are complicated or that were created by other people.
📌 Unity offers little to no support for documenting your prefabs. This is a huge deficiency when working in larger teams, where multiple people will touch a single prefab over a long duration of time.
📌 Some point out you can add documentation to external sources like a Google Doc. But this is inconvenient, easy to forget, and error-prone for updating.
📌 Imagine NOT being able to comment your code in the file, but instead having to add every comment to a Google Doc instead. This would be a disaster.
📌 The best documentation is in the code. And the best documentation is in the prefab.
📌 So how do we do this and how do we do it without a performance cost?
📌 I've created an editor script that allows you to comment directly inside your prefab or scene.
📌 Anything starting with the prefix "//" will automatically highlight as green, giving you a visual line break.
📌 Don't worry about performance, because these comments are automatically tagged as EditorOnly. This means Unity will strip these game objects out of builds.
📌 There are other Unity tools that do this, but they always add ugly backgrounds and messy color schemes. My tool is lightweight, performant, and allows you to easily document your prefabs and scenes without any fuss.
📌 Documentation standards do apply, and you want to make sure your comments are short, clean, and convey useful information.
📌 Simple, straight forward, and performant, I hope this tool helps your development process in small and large teams.
Download Free Here
Me First Games is an independent game studio dedicated to creating unique and bizarre video games.
Star Impact is an upcoming adventure platformer coming to PC, Mac, and Linux.
Copyright (c) 2020 Me First LLC