Coding style with generics and inheritance

Question

Possible Duplicate:
How to name C# source files for generic classes

We are currently re-evaluating how we do generic classes when we inherit from a general class. Currently we will put the following two class definitions in the same file

class Foo
{
    // code for class
}

class Foo<T> : foo
{
   // code for class
}

My question is a simple one, should we keep them in the same file, or split them into separate files?

So far the pros to keeping them in the same file is that you have all the code there right infront of you. The con is that when both classes get sufficiently large, it could become un-readable.

What I would like is good reasons as to why we should do one or the other. If you recommend separate file, I would also like you to include possible naming conventions, or a strategy to get around the fact that we can have only one file named Foo

A couple of the answers here link to [this question](http://stackoverflow.com/questions/3108189/how-to-name-c-sharp-source-files-for-generic-classes/3108243#3108243), which seems to be asking the same thing. — Matthew Strawbridge, Dec 30 '11 at 17:14

Jay · Accepted Answer · 2011-12-30T17:24:34.500

5

This is a matter of opinion, but I'd keep them in the same file rather than try to maintain some naming convention for one or the other.

While I subscribe to one class, one file, I think there is value in having these together. We really treat these as one class, right? Typically, Foo will be abstract, and is just a way of using our generic types… well, more generically -- in places where the type parameters don't matter and can't be known at compile time.

If the classes become too large, it should be a red flag anyway that some responsibilities should be broken out.

edited Dec 30 '11 at 17:24

answered Dec 30 '11 at 16:55

Jay

56,361
10
99
123

Indeed it is a matter of opinion, and this isn't a bad answer at all, though it's the opposite of mine. +1 – Andrew Barber Dec 30 '11 at 16:57
That too is a valid opinion and definitely requires consideration. – Zoidberg Dec 30 '11 at 17:12

score 1 · Answer 2 · edited May 23 '17 at 12:03

1

Keep these classes small and you can keep them in one file. If you can't keep them small, divide them. If you prefer keeping them in separate files, it's okay too. But keep them small anyway. In case of separate file, I would use FooGeneric name but someone here How to name C# source files for generic classes recommends Foo`1 (for 1 parameter).

edited May 23 '17 at 12:03

Community

1
1

answered Dec 30 '11 at 16:55

Pol

5,064
4
32
51

score 1 · Answer 3 · answered Dec 30 '11 at 16:55

1

Unless classes are utterly trivial, I never put more than one in a single file. It's much easier, IMO, to find exactly the class you seek when you have a predictable, unique file name, with namespaces based on folders, generally.

For naming your files, maybe this:

foo.cs
foo_t.cs
foo_tuv.cs // for a foo class with three generics

answered Dec 30 '11 at 16:55

Andrew Barber

39,603
20
94
123

as Jay notes in his answer, this is a matter of style opinion. – Andrew Barber Dec 30 '11 at 16:56

score 1 · Answer 4 · answered Dec 30 '11 at 16:55

I'd recommend keeping the classes in the same file. It makes it easier to locate all Foo classes. Also, with code folding (regions) you can easily view only a single class by collapsing the other.

That said, I wouldn't say either way is wrong. In the end this is one of those things that will take some experience to come up with your personal preference and find what works for you in your particular project. And you may find that what works well for one project doesn't necessarily work for your next project.

score 1 · Answer 5 · edited May 23 '17 at 12:12

1

Answered here:

I think the common solution to this problem is to name the file like this:

{ClassName}`{NumberOfGenericParameters}

This would give you this filename:

Bag.cs and Bag`1.cs

This is the way Microsoft handle this issue in frameworks like Asp.net Mvc.

edited May 23 '17 at 12:12

Community

1
1

answered Dec 30 '11 at 16:56

Jesse Smith

963
1
8
21

Coding style with generics and inheritance

5 Answers5