90 सी ++ लेखन शैलियाँ

अनुवादक से। मैंने C ++ प्रोग्राम लिखने के लिए एक सरल और आसानी से लागू दिशानिर्देश के लिए इंटरनेट पर खोज की। मुझे विकल्पों में से एक पसंद आया, और मैंने इसका अनुवाद और प्रकाशन करने का फैसला किया। यदि साइट के उपयोगकर्ता इस विषय को अच्छी तरह से पूरा करते हैं, तो मैं अन्य संबंधित दस्तावेजों का अनुवाद कर सकता हूं, साथ ही अन्य कंपनियों से कोड लिखने के लिए दिशानिर्देश भी।

1 परिचय

यह दस्तावेज़ C ++ प्रोग्राम लिखने के लिए दिशानिर्देश प्रदान करता है।

सिफारिशें विभिन्न स्रोतों, व्यक्तिगत अनुभव, विशेष आवश्यकताओं और कुछ परियोजनाओं की जरूरतों से एकत्र मानकों पर आधारित होती हैं, साथ ही स्रोतों से चमकती हैं (नीचे देखें)।

लेकिन इन स्रोतों के अलावा, सिफारिशों की एक और सूची के उद्भव के लिए, कई कारण हैं। मुख्य कारण उनका अत्यधिक सामान्यीकरण है, क्योंकि अक्सर विशेष नियम (विशेष रूप से नामकरण नियम) निर्धारित करना आवश्यक होता है। इस दस्तावेज़ में टिप्पणियां हैं, जो अन्य मौजूदा दस्तावेज़ों की तुलना में कोड ऑडिट आयोजित करते समय उपयोग करना अधिक सुविधाजनक बनाता है। इसके अलावा, प्रोग्रामिंग सिफारिशों में आमतौर पर शैली की समस्याओं और तकनीकी समस्याओं का वर्णन होता है, जो बहुत सुविधाजनक नहीं है। इस दस्तावेज़ में C ++ पर कोई तकनीकी सलाह नहीं है, जो शैली के मुद्दों पर केंद्रित है।

मौजूदा विकास वातावरण पहुँच संशोधक, कोड हाइलाइटिंग, स्वचालित स्वरूपण, और बहुत कुछ दिखा कर कोड पठनीयता में सुधार कर सकते हैं, लेकिन प्रोग्रामर को इन उपकरणों पर भरोसा नहीं करना चाहिए। स्रोत कोड को न केवल उपयोग किए गए विकास पर्यावरण के ढांचे के भीतर माना जाना चाहिए और लिखा जाना चाहिए ताकि पर्यावरण की परवाह किए बिना पठनीयता को अधिकतम किया जा सके।

1.1 दस्तावेज़ प्रारूप

सिफारिशें विषय द्वारा वर्गीकृत की जाती हैं और क्रमांकित की जाती हैं ताकि कोड संशोधन के दौरान उन्हें संदर्भित किया जा सके।

अनुशंसाएँ निम्नानुसार प्रदर्शित की जाती हैं:

एन। सिफारिश का एक संक्षिप्त विवरण।

//   ( )

, .

, «», .

1.2

: , .

2

1. , .

— , , , . , .

2. , .

, . . , ( ), .

, .

3

3.1

3. , , , .

Line, SavingsAccount

C++.

4. , .

line, savingsAccount

C++. , , : Line line;

5. ( ) .

MAX_ITERATIONS, COLOR_RED, PI

C++. . — :

  int getMaxIterations() // : MAX_ITERATIONS = 25
  {
    return 25;
  }

, .

6. , .

getName(), computeTotalWidth()

, .

7. .

model::analyzer, io::iomanager, common::math::geometry

C++.

8. .

template<class T> ...
template<class C, class D> ...

C++. .

9. .

exportHtmlSource(); // : exportHTMLSource();
openDvdPlayer();    // : openDVDPlayer();

, . dVD, hTML . ., . ; , ; , , , .

10. (::).

::mainWindow.open(), ::applicationContext.getName()

. .

11. private -.

class SomeClass {
  private:
    int length_;
}

, — . . , , , .

- , , :

  void setDepth (int depth)
  {
    depth_ = depth;
  }

, — . , , . , — . , .

12. , .

void setTopic(Topic* topic)      // : void setTopic(Topic* value)
                                 // : void setTopic(Topic* aTopic)
                                 // : void setTopic(Topic* t)

void connect(Database* database) // : void connect(Database* db)
                                 // : void connect (Database* oracleDB)

. .

- , , .

:

  Point  startingPoint, centerPoint;
  Name   loginName;

13. -.

fileName;   //  : imyaFayla

.

14. , , , — .

, , . , , , . i, j, k, l, m, n ( ), c d ( ).

15. , .

line.getLength();   //  : line.getLineLength();

, , .

( № 16 .— .)

3.2

17. get/set , .

employee.getName();
employee.setName(name);

matrix.getElement(2, 4);
matrix.setElement(2, 4, value);

C++. Java - .

18. compute , -.

valueSet->computeAverage();
matrix->computeInverse()

, .

19. find , - .

vertex.findNearestVertex();
matrix.findMinElement();

, , .

20. initialize , .

printer.initializeFontSet();

initialize, initialise. init.

21. , GUI, , .

mainWindow, propertiesDialog, widthScale, loginText,
leftScrollbar, mainForm, fileMenu, minLabel, exitButton, yesToggle  . .

, , , .

22. () .

vector<Point>  points;
int            values[];

, , .

23. n .

nPoints, nLines

, .

24. No .

tableNo, employeeNo

, .

i: iTable, iEmployee. , .

25. - i, j, k . .

for (int i = 0; i < nTables); i++) {
  :
}

for (vector<MyClass>::iterator i = list.begin(); i != list.end(); i++) {
  Element element = *i;
  ...
}

, .

j, k . . .

26. is () .

isSet, isVisible, isFinished, isFound, isOpen

C++, Java.

, status flag. isStatus isFlag , .

is : has, can should:

  bool hasLicense();
  bool canEvaluate();
  bool shouldSort();

27. .

get/set, add/remove, create/destroy, start/stop, insert/delete,
increment/decrement, old/new, begin/end, first/last, up/down, min/max,
next/previous, old/new, open/close, show/hide, suspend/resume,  . .

.

28. .

computeAverage();   // : compAvg();

. — , , . :

cmd        command
cp         copy
pt         point
comp       compute
init       initialize
 . .

— , - , /. . :

 HypertextMarkupLanguage      html
 CentralProcessingUnit        cpu
 PriceEarningRatio            pe
  . .

29. .

Line* line; //  : Line* pLine;
            //  : Line* linePtr;

C/C++ . , C++ , .

30. () , .

bool isError; // : isNoError
bool isFound; // : isNotFound

, , . !isNotFound.

31. — .

enum Color {
  COLOR_RED,
  COLOR_GREEN,
  COLOR_BLUE
};

, , , .

: Color::RED, Airline::AIR_FRANCE . .

, , : enum Color {...}. , .

32. Exception.

class AccessException
{
  :
}

, .

33. (, - ) , , — , ( void).

. , , , .

4

4.1

34. C++ .h () .hpp. .c++ (), .C, .cc .cpp.

MyClass.c++, MyClass.h

, C++.

35. () , .

MyClass.h, MyClass.c++

. — , .

36. .

class MyClass
{
public:
  int getValue () {return value_;}  // !
  ...

private:
  int value_;
}

, . , , .

37. 80 .

80 — , , ; , . .

38. (, TAB) .

, , , .

39. .

totalSum = a + b + c +
           d + e;

function (param1, param2,
          param3);

setText ("Long line split"
         "into two parts.");

for (int tableNo = 0; tableNo < nTables;
     tableNo += tableStep) {
  ...
}

, 80 , , . , .

:

• ;
• ;
• .

4.2

40. .

#ifndef COM_COMPANY_MODULE_CLASSNAME_H
#define COM_COMPANY_MODULE_CLASSNAME_H
  :
#endif // COM_COMPANY_MODULE_CLASSNAME_H

. .

41. ( , — ) . .

#include <fstream>
#include <iomanip>

#include <qt/qbutton.h>
#include <qt/qtextfield.h>

#include "com/company/ui/PropertiesDialog.h"
#include "com/company/ui/MainWindow.h"

. .

42. .

. , «» - .

5

5.1

43. , , .

.

44. public, protected private . .

public, protected/private.

45. . .

floatValue = static_cast<float>(intValue); // : floatValue = intValue;

, , .

5.2

46. .

, . :

  int x, y, z;
  getCenter(&x, &y, &z);

, - .

47. .

, , . - .

48. .

C++ ( .— ). () , — .

49. public.

. private . — , ( C). .

, C++ C; . .

( № 50 .— .)

51. C++ , .

float* x; //  : float *x; 
int& y;   //  : int &y;

, — , , . C , C++ .

( № 52 .— .)

53. () .

if (nLines != 0)  //  : if (nLines)
if (value != 0.0) //  : if (value)

C++ , int float, , 0. .

, , , if (line == 0) if (line). C/C++, .

54. .

.

5.3

55. for() , .

sum = 0;                       // : for (i = 0, sum = 0; i < 100; i++)
for (i = 0; i < 100; i++)                sum += value[i];
  sum += value[i];

. , .

56. , , .

isDone = false;           //  : bool isDone = false;
while (!isDone) {         //      :
  :                       //      while (!isDone) {
}                         //        :
                          //      }

57. do-while.

, . , .

do-while . while for.

.

58. break continue .

, .

( № 59 .— .)

60. while (true) .

while (true) {
  :
}

for (;;) {  // !
  :
}

while (1) { // !
  :
}

. for (;;) ; , .

5.4

61. . .

bool isFinished = (elementNo < 0) || (elementNo > maxElement);
bool isRepeatedEntry = elementNo == lastElement;
if (isFinished || isRepeatedEntry) {
  :
}

// NOT:
if ((elementNo < 0) || (elementNo > maxElement)||
     elementNo == lastElement) {
  :
}

. , .

62. if, — else.

bool isOk = readFile (fileName);
if (isOk) {
  :
}
else {
  :
}

, . .

63. .

if (isDone)       //  : if (isDone) doCleanup();
  doCleanup();

.

64. .

File* fileHandle = open(fileName, "w");
if (!fileHandle) {
  :
}

// :
if (!(fileHandle = open(fileName, "w"))) {
  :
}

. /++.

5.5

65. «» . , 0 1, .

, . — , .

66. .

double total = 0.0;    //  :  double total = 0;
double speed = 3.0e8;  //  :  double speed = 3e8;

double sum;
:
sum = (a + b) * 10.0;

. , .

( ) (sum) , .

67. , , .

double total = 0.5;  //  :  double total = .5;

C++ , , . , 0.5 — , .5 ( 5).

68. .

int getValue()   // : getValue()
{
  :
}

, C++ , int. , , .

69. goto.

. (, ), .

70. «0» «NULL».

NULL C C++.

6

6.1

71. .

for (i = 0; i < nElements; i++)
  a[i] = 0;

, . 4 , . 2, 3 4 ; 2 4 — .

72. , 1 () 2, , 3. 2.

while (!done) {
  doSomething();
  done = moreToDo();
}

while (!done)
{
  doSomething();
  done = moreToDo();
}

while (!done)
  {
    doSomething();
    done = moreToDo();
  }

3 , .

73. :

class SomeClass : public BaseClass
{
  public:
    ...

  protected:
    ...

  private:
    ...
}

, .

74. :

void someMethod()
{
  ...
}

, .

75. if-else :

if (condition) {
  statements;
}

if (condition) {
  statements;
}
else {
   statements;
}

if (condition) {
  statements;
}
else if (condition) {
  statements;
}
else {
  statements;
}

, . else , , :

  if (condition) {
    statements;
  } else {
    statements;
  }

if-else . , , else.

76. for :

for (initialization; condition; update) {
  statements;
}

, .

77. for :

for (initialization; condition; update)
  ;

, . , , .

78. while :

while (condition) {
  statements;
}

, .

79. do-while :

do {
  statements;
} while (condition);

, .

80. switch :

switch (condition) {
  case ABC :
    statements;
    //  "break"

  case DEF :
    statements;
    break;

  case XYZ :
    statements;
    break;

  default :
    statements;
    break;
}

, case , . . - break, . , .

81. try-catch :

try {
  statements;
}
catch (Exception& exception) {
  statements;
}

, . , if-else, .

82. if-else , .

if (condition)
  statement;

while (condition)
  statement;

for (initialization; condition; update)
  statement;

.

83. .

void
MyClass::myMethod(void)
{
  :
}

.

6.2

84.

— .
— C++ .
— .
— .
— for .

a = (b + c) * d; //  : a=(b+c)*d

while (true)   //  : while(true) 
{
  ...

doSomething(a, b, c, d);  //  : doSomething(a,b,c,d);

case 100 :  //  : case 100:

for (i = 0; i < 10; i++) {  //  : for(i=0;i<10;i++){
  ...

. . C++. .

85. , .

doSomething (currentFile);

. . , (doSomething()).

. : doSomething( currentFile );. ; , (doSomething( currentFile);).

86. .

Matrix4x4 matrix = new Matrix4x4();

double cosAngle = Math.cos(angle);
double sinAngle = Math.sin(angle);

matrix.setElement(1, 1,  cosAngle);
matrix.setElement(1, 2,  sinAngle);
matrix.setElement(2, 1, -sinAngle);
matrix.setElement(2, 2,  cosAngle);

multiply(matrix);

.

87. .

.

88. .

AsciiFile* file;
int        nPoints;
float      x, y;

. — .

89. , .

if      (a == lowValue)    compueSomething();
else if (a == mediumValue) computeSomethingElse();
else if (a == highValue)   computeSomethingElseYet();

value = (potential        * oilDensity)   / constant1 +
        (depth            * waterDensity) / constant2 +
        (zCoordinateValue * gasDensity)   / constant3;

minPosition     = computeDistance(min,     x, y, z);
averagePosition = computeDistance(average, x, y, z);

switch (value) {
  case PHASE_OIL   : strcpy(phase, "Oil");   break;
  case PHASE_WATER : strcpy(phase, "Water"); break;
  case PHASE_GAS   : strcpy(phase, "Gas");   break;
}

, , .

6.3

90. , , , !

, .

91. .

— .

92. // , .

// , 
//   .

, /* */ .

// , .

93. , , .

while (true) {       //  :  while (true) { 
  // Do something                          // Do something
  something();                               something();
}                                          }

, , .

94. JavaDoc.

Java Javadoc, HTML .

C++. , JavaDoc (., , Doc++ Doxygen).

7

• Code Complete, Steve McConnell — Microsoft Press
• Programming in C++, Rules and Recommendations, M Henricson, e. Nyquist, Ellemtel (Swedish telecom): http://www.doc.ic.ac.uk/lab/cplus/c%2b%2b.rules/
• Wildfire C++ Programming Style, Keith Gabryelski, Wildfire Communications Inc.: http://www.wildfire.com/~ag/Engineering/Development/C++Style/
• C++ Coding Standard, Todd Hoff: http://www.possibility.com/Cpp/CppCodingStandard.htm
• Doxygen documentation system: http://www.stack.nl/~dimitri/doxygen/index.html