QA·C Help - 1517

	1517	Different files are being used which have the same filename 'filename', and one includes the other.

CMA maintenance checks

As with type, object and function names, the name used for a file should also help document the purpose of that file.

If two files in a project share the same name it may be that the names are not descriptive enough leading to extra maintenance effort.

There is one situation where using the same identical filename may have been intentional. This is in the case of forwarding headers, where an extra header file exists in a 'public' directory.

Example:


// impl/x.h
struct X
{
};

// include/x.h
#include "../impl/x.h"


// main.cc
#include "x.h"            // finds impl/x.h via include/x.h

See also:

1515 Different files are being used which have the same filename 'filename'.
1516 Different files are being used which have similar filenames 'filename', but with different case.

Personality Groups | Glossary | Message Index

Contents