yade-users team mailing list archive

[Anton Gladky <gladky.anton@xxxxxxxxx>]

Thank you for explanation.

But I think it would be good to have exact rules on style. Code must be in
order. Maybe, it is good to create some rules for new added code?

Best Regards / Mit freundlichen Grüßen /  С наилучшими пожеланиями

Anton Gladkyy


2009/5/19 Václav Šmilauer <eudoxos@xxxxxxxx>

> > Actually, I have not found an accurate instructions according to
> > writing style of YADE: what indents, how to write brackets, what is
> > the maximal string length etc.
> > Where can I get it?
>
> Right here :-) Tabs to indent, otherwise no instructions.  Everybody
> would tell you about his/her own taste so there is no policy. (I prefer
> spartan spacing, few linebreaks and longer lines as I have 24" panel,
> for that matter).
>
> Apart from this makeup style: IMPORTANT!! Always keep in mind that other
> people will read your code: make sure you write comments and that
> purpose of every class is clearly documented, preferrably both in the
> header file and by providing a sample script on how to use it, for
> example. The doxygen-style comments for all class members are also
> desirable. If you are developing a bigger set of classes that cooperate
> in some way, create a wiki page on that particular setup (like
>
> http://yade.wikia.com/wiki/Speed_profiling_using_TimingInfo_and_TimingDeltas_classes)
> and put reference to the wiki page into sources or elsewhere.
>
> Welcome on board.
>
> Vaclav
>
>
>
> _______________________________________________
> Mailing list: https://launchpad.net/~yade-users<https://launchpad.net/%7Eyade-users>
> Post to     : yade-users@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~yade-users<https://launchpad.net/%7Eyade-users>
> More help   : https://help.launchpad.net/ListHelp
>