When should methods be made private?

There are lots of times where I'm not sure whether a particular method should be made private or not. For example, I'm building a class right now, which, is responsible for generating a report. This class has a buildReport method and several methods which collect the necessary data for buildReport.

// single public method
// uses a set of helper methods
public buildReport()

// helper methods
private avgSurveyTime()
private fetchVendors()
private fetchSendCounts()
private ...

I'm debating whether I should make these helper methods public. The only method I really plan on calling 开发者_Go百科outside at the moment is buildReport(). However, it might be useful to get just a list of the vendors with fetchVendors() etc.

I see two schools of thought on this: You can always expose as little as possible. (In which case, many of my classes would only have one public method) OR you can expose all you can that might be useful to the user of the class.

Is there a good rule of thumb to use for deciding when methods should be made public/private?

The only rule I follow is to make as little as possible public.

Look at it this way. You can always make something public later on - it won't break any existing code. Trying to make something private that was public could well end up breaking a lot of existing code.

If someone wants more functionality from your class then they can make the request and you can expose what they need. Chances are that they'll want something that's subtly different to what you already have anyway so you'll need a new interface.

A helpful guidance technique to follow is to write an interface for your class before you start the implementation. Then when implementing, tell yourself that a method not in the interface should be private, or not in that class at all.

If you didn't know a method needed to be there when you were designing the contract of the class, it probably shouldn't be part of its public interface.

1. You should expose to the outside world only what the outside world really needs. It is often best to add functionality for consumers of the class when it is needed, rather than at first. These days the wisdom is to avoid pre-engineering. (see YAGNI)

2. It can certainly be acceptable to have public methods that are also used by other functionality within the class. However, this should be considered a minor bad smell. It might be an indication that your class is trying to do too many things.

My guess is to leave your classes as they are. Then, when these other, smaller methods are needed by the outside world, consider if you should separate your classes. If the purpose of each of these classes to to yield one report, then you should not expose these methods from this object. Instead, put "smaller" methods into a common helper class. That way they are available to the outside world without fundamentally changing the nature of your existing report classes. In short:

Don't just do it because you think it might be helpful later. If/When the additional functionality is needed, reconsider your overall design to accommodate the new requirements.

Public and private methods are very different beasts. Use caution before making a method public.

• Public methods must validate all of their parameters.
• They must be properly documented, including any exceptions that they might throw.
• All edge cases must be analyzed and delt with (in code or in documentation).
• Any requirements involving the order in which public methods are called must be documented or, preferably, removed.
• Object state requirements must also be documented and validated.
• Public methods must not change their signature or behavior in any way that may break an application when moving from one version to the next.
• Public methods may need to be designed with marshalling requirements. (Such as .Net's CLS restrictions.)

Private methods have none of these limitations.

If it's not needed outside the class it is in at that very moment, make it private. If later it is, you can make it protected or public as needed.

When in doubt - make it private.

If the class is for internal use within your organization, i.e. you are not distributing this as a general-use library, then I heartily agree that you should make as much private or protected as possible. If later you discover that some other class needs access to a private function, fine, at that point change it to public. It's not hard to do.

My only caveat would be if this is something you are "publishing", where others who do not have a direct line to get changes made will be using it. Then you need to carefully think out a complete API.

But failing that, just write the code you need. Don't write functions that you think you might use someday.

Generally you should expose as little as possible and make everything private that is possible.

If you make a mistake and hide something you should be exposing, no problem, just make it public. However, if you make something public and then later decide it should be private, then you may have problems because now the public method may be used by many other classes.

You are free to change implementation of your private methods without any external effects. If you have all public classes, that may not be possible, because those methods could be used by somethings outside your classes.

I always follow this: "Design for tomorrow, code for today."

If today you need only one public method then keep only one public method.

The rule is that a method should be made provided unless it is needed. One of the main reasons for this is that in a future release of an API etc., you can always make a private function public, but you can almost never make a previous public function private without breaking existing code.

Everything not included in the class's interface should (must, really) be private. If you're not sure what the class's interface is (i.e., you're not http://www.artima.com/lejava/articles/designprinciples.html>programming to interfaces or those interfaces aren't yet fully defined, start with everything private and make things public, protected, package-private, etc. as needed.

But think carefully! Once something is accessible to other code, there's a dependency between that code and this class and refactoring is constrained. Rule of thumb: Expose only those methods that define the abstraction, not how it's implemented.

simple rules:

1. If you are not looking to expose it outside of the class that is using it, make it PRIVATE.

2. If you are looking to expose it inside the same assembly to other classes but not outside the assembly, make it INTERNAL (C#) / Friend (VB.NET).

3. If you are looking to expose the functionality outside the assembly to everyone, make it PUBLIC

I am working on a system made up of mainly two things : importing data from various sources, and generating reports. The problem is that the whole thing was designed by someone lacking basic OO design skills. In the same 'class' they would have 'private' methods to read data from a database, calling 'private' methods to validate said data, which is also being called by another 'private' 500-line function duplicated more or less in the whole application which simply formats said data.

You should move away private avgSurveyTime() private fetchVendors() private fetchSendCounts() from the actual class which handles page layout.