An Example of the Comments

|  Overview |  How Do I |  |  Tutorial

The following partial listing of class CStdioFile uses most of the standard comments that MFC employs in its classes to divide class members by the ways they are used:

class CStdioFile : public CFile
{
    DECLARE_DYNAMIC(CStdioFile)

public:
// Constructors
    CStdioFile();
...

// Attributes
    FILE* m_pStream;    // stdio FILE
...

// Operations
    virtual void WriteString(LPCTSTR lpsz);
...
    virtual LPTSTR ReadString(LPTSTR lpsz, UINT nMax);
...

// Implementation
public:
...
};

These comments consistently mark sections of the class declaration that contain similar kinds of class members. Keep in mind that these are MFC conventions, not set rules.

What do you want to know more about?

• The // Implementation comment

• The // Constructors comment

• The // Attributes comment

• The // Operations comment

• The // Overridables comment