Please document packages/libraries before putting them on dub registry

solidstate1991 via Digitalmars-d digitalmars-d at puremagic.com
Sat Aug 5 15:38:35 PDT 2017


On Saturday, 5 August 2017 at 00:08:29 UTC, aberba wrote:
> Those packages without documentation might be useful but no one 
> except you will use it because only you know how and what it 
> does. We spend hours writing code but can't spend minutes 
> getting people to use them.
>
> Intro
> Purpose
> Usage
> ...
> To do
> Contributions
>
> Basic stuff.

I'm currently working on this alongside with my code.

Tip: Name all your variables after what they supposed to do, this 
further helps understanding your code. Using "foo" and "bar" 
might be trendy among programmers, but it can ruin code 
readability (to the point I once had to completely rewrite an 
algorithm instead of simply updating it).

Also can I skimp out on details if a certain function only 
supposed to simply return a value (eg. getters, I usually write 
some warnings for setters even if they're pretty short).


More information about the Digitalmars-d mailing list