Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [mylyn-reviews-dev] Coding guidelines for Mylyn

I agree there is always some exceptions.  I did a search in my workspace “public interface” and I got ~200 matches. When I look at some project, most when not all definition of the Interface start with an “I..”. Some projects like

Mylyn.task.core, mylyn.reviews.ui follows the convention, but when I look at mylyn.gerrit.core or mylyn.reviews.example.emf…, only one interface start with an “I” and all the others don’t.  May be it should be the opposite , only a subset might not follow the coding convention, not the majority J Unless the standard is to not put the “I” at the beginning!

 

As the main project (Mylyn), it would be nice to follow its own coding standards J and show the good way

 

 

From: mylyn-reviews-dev-bounces@xxxxxxxxxxx [mailto:mylyn-reviews-dev-bounces@xxxxxxxxxxx] On Behalf Of Miles Parker
Sent: June-11-14 1:39 PM
To: Mylyn Reviews Project
Subject: Re: [mylyn-reviews-dev] Coding guidelines for Mylyn

 

 

There are always exceptions, of course. ;) (In general, Eclipse tends to be pretty interface averse, for reasons of API extensibility.)

 

On code conventions in general, it’s probably impossible to have a complete list of all conventions beyond the clear ones like naming conventions and so on. So I think some of these will always be defined and enforced culturally; that is through the reviews process itself.

 

On Jun 11, 2014, at 9:29 AM, Sam Davis <sam.davis@xxxxxxxxxxx> wrote:



For the most part I think we follow that convention.



--
Sam Davis
Software Engineer, Tasktop Dev
Committer, Eclipse Mylyn
http://tasktop.com

 

On Wed, Jun 11, 2014 at 8:50 AM, Jacques Bouthillier <jacques.bouthillier@xxxxxxxxxxxx> wrote:

Thanks for the info.

 

One thing I noticed in the document I was referring to is for the interface . All interface should start with “I…”

I think this would also help within Mylyn code. Everyone would know when we refer to an interface

They seems to rely on eclipse standard in their document.

 

Jacques

From: mylyn-reviews-dev-bounces@xxxxxxxxxxx [mailto:mylyn-reviews-dev-bounces@xxxxxxxxxxx] On Behalf Of Sam Davis
Sent: June-11-14 11:45 AM
To: Mylyn Reviews Project
Cc: Mylyn developer discussions
Subject: Re: [mylyn-reviews-dev] Coding guidelines for Mylyn

 

P.S. The document you linked to is for the Code Recommenders project. I'm not sure how much it differs from the Eclipse conventions.



--
Sam Davis
Software Engineer, Tasktop Dev
Committer, Eclipse Mylyn
http://tasktop.com

 

On Wed, Jun 11, 2014 at 8:43 AM, Sam Davis <sam.davis@xxxxxxxxxxx> wrote:

Hi Jacques,

According to the contributor reference, Mylyn uses the Eclipse code conventions.

Sam



--
Sam Davis
Software Engineer, Tasktop Dev
Committer, Eclipse Mylyn
http://tasktop.com

 

On Wed, Jun 11, 2014 at 8:32 AM, Jacques Bouthillier <lmcbout@xxxxxxxxx> wrote:

Hi ,

I would like to know if there is a written document to follow for the coding rules styles and coding guidelines when modifying or adding code to any Mylyn project.

 

 There is one that exist for eclipse project:

 

Is it the one to follow?

Thanks

Jacques

 

 

_______________________________________________
mylyn-reviews-dev mailing list
mylyn-reviews-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/mylyn-reviews-dev

 

 


_______________________________________________
mylyn-reviews-dev mailing list
mylyn-reviews-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/mylyn-reviews-dev

 

_______________________________________________
mylyn-reviews-dev mailing list
mylyn-reviews-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/mylyn-reviews-dev

 

-- 
Miles Parker
Senior Software Engineer, Tasktop
Committer, Eclipse Mylyn, Virgo
http://tasktop.com 
skype: milestravisparker

 


Back to the top