[Xerte-dev] Re: Comments...

[Pat @ Pgogy]

php ones used to be PHPDoc'ed?


On Tue, Dec 3, 2013 at 9:51 PM, Mark Berthelemy <
mberthelemy at wyversolutions.co.uk> wrote:

> Hi John,
>
> I agree that download times need to be watched. But there must be a happy
> medium between fully commented and hardly any comments at all?
>
> It's not just the JS/CSS files. It's the php ones too.
>
> Cheers,
>
> Mark
>
> -----
> Mark Berthelemy
> 07922 146 761
>
> > On 3 Dec 2013, at 21:15, "Smith, John" <J.J.Smith at gcu.ac.uk> wrote:
> >
> > The problem is if do we comment the Javascript/CSS files properly then
> it will bloat the resulting download increasing load times, especially on
> mobile. We would then really need to minify them, not that we don't already.
> >
> > Regards,
> >
> > John Smith | Learning Technologist
> > Room A251, Govan Mbeki Building | School of Health & Life Sciences |
> Glasgow Caledonian University
> > Cowcaddens Road | Glasgow | G4 0BA
> > ________________________________________
> > From: xerte-dev-bounces at lists.nottingham.ac.uk [
> xerte-dev-bounces at lists.nottingham.ac.uk] On Behalf Of Mark Berthelemy [
> mberthelemy at wyversolutions.co.uk]
> > Sent: 03 December 2013 20:03
> > To: developers For
> > Subject: [Xerte-dev] Comments...
> >
> > Hi all,
> >
> > Can I make a plea for comments in the code we're creating. At least
> something in each file that says what it's for would be useful!
> >
> > I know it's a chore, but it would help wider adoption, and make it so
> much easier to document the code.
> >
> > Thanks,
> >
> > Mark
> >
> > --
> > Mark Berthelemy
> > Managing Director
> > Tel: 01773 318 962
> > Mob: 07922 146 761
> > Web: www.wyversolutions.co.uk
> >
> > Wyver Solutions Ltd | Company number: 5731173 Registered in England |
> Registered address: First Floor, 6 Bridge Street, Belper, Derbyshire, DE56
> 1AX
> >
> >
> > Glasgow Caledonian University is a registered Scottish charity, number
> SC021474
> >
> > Winner: Times Higher Education’s Widening Participation Initiative of
> the Year 2009 and Herald Society’s Education Initiative of the Year 2009.
> >
> http://www.gcu.ac.uk/newsevents/news/bycategory/theuniversity/1/name,6219,en.html
> >
> > Winner: Times Higher Education’s Outstanding Support for Early Career
> Researchers of the Year 2010, GCU as a lead with Universities Scotland
> partners.
> >
> http://www.gcu.ac.uk/newsevents/news/bycategory/theuniversity/1/name,15691,en.html
> > _______________________________________________
> > Xerte-dev mailing list
> > Xerte-dev at lists.nottingham.ac.uk
> > http://lists.nottingham.ac.uk/mailman/listinfo/xerte-dev
>
> _______________________________________________
> Xerte-dev mailing list
> Xerte-dev at lists.nottingham.ac.uk
> http://lists.nottingham.ac.uk/mailman/listinfo/xerte-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.nottingham.ac.uk/pipermail/xerte-dev/attachments/20131203/a64098c6/attachment.html>