3 ms·
Document the codebase, in my experience it helps. In case of JavaScript you’d probably use something like JSDoc. Describe your units and make the tool automati
by goblin89 11y ago
Document the codebase, in my experience it helps.
In case of JavaScript you’d probably use something like JSDoc. Describe your units and make the tool automatically create beautiful HTML out of that. You don’t have to document everything at once but be sure to lay the groundwork, automate documentation build process, and in general try to make maintaining the docs effortless (for yourself and for others). Take some existing well-documented JavaScript codebase as an example.
This’d make a great contribution already: SlickGrid’s codebase is somewhat poorly documented, which is a barrier to the involvement of interested developers.
As you write the docs weak spots in existing implementation will come to your attention, helping you figure out what to fix first.
One downside is that writing down and structuring your knowledge in easy for others to grasp way is a challenge in itself, though arguably a useful exercise.