#ifdef vs #if - วิธีใดดีกว่า / ปลอดภัยกว่าสำหรับวิธีการเปิด / ปิดการรวบรวมโค้ดบางส่วน

นี่อาจเป็นเรื่องของรูปแบบ แต่มีความแตกแยกเล็กน้อยในทีม dev ของเราและฉันสงสัยว่ามีใครมีความคิดเกี่ยวกับเรื่องนี้บ้าง ...

โดยทั่วไปเรามีคำสั่งพิมพ์ดีบักซึ่งเราปิดในระหว่างการพัฒนาตามปกติ โดยส่วนตัวแล้วฉันชอบทำสิ่งต่อไปนี้:

//---- SomeSourceFile.cpp ----

#define DEBUG_ENABLED (0)

...

SomeFunction()
{
    int someVariable = 5;

#if(DEBUG_ENABLED)
    printf("Debugging: someVariable == %d", someVariable);
#endif
}

บางทีมชอบสิ่งต่อไปนี้:

// #define DEBUG_ENABLED

...

SomeFunction()
{
    int someVariable = 5;

#ifdef DEBUG_ENABLED
    printf("Debugging: someVariable == %d", someVariable);
#endif
}

... วิธีใดที่เหมาะกับคุณมากกว่าและเพราะเหตุใด ความรู้สึกของฉันคืออย่างแรกปลอดภัยกว่าเพราะมีบางสิ่งที่กำหนดไว้เสมอและไม่มีอันตรายที่จะไปทำลายนิยามอื่นที่อื่นได้

#ifdefแน่นอนว่าปฏิกิริยาเริ่มต้นของฉันคือแต่ฉันคิดว่า#ifจริงๆแล้วมีข้อดีที่สำคัญสำหรับสิ่งนี้ - นี่คือเหตุผล:

ขั้นแรกคุณสามารถใช้DEBUG_ENABLEDในการทดสอบตัวประมวลผลก่อนและคอมไพล์ ตัวอย่าง - บ่อยครั้งฉันต้องการการหมดเวลานานขึ้นเมื่อเปิดใช้งานการดีบักดังนั้นการใช้#ifฉันสามารถเขียนสิ่งนี้ได้

  DoSomethingSlowWithTimeout(DEBUG_ENABLED? 5000 : 1000);

... แทน ...

#ifdef DEBUG_MODE
  DoSomethingSlowWithTimeout(5000);
#else
  DoSomethingSlowWithTimeout(1000);
#endif

ประการที่สองคุณอยู่ในตำแหน่งที่ดีขึ้นหากคุณต้องการย้ายจาก#defineค่าคงที่ไปเป็นค่าคงที่ทั่วโลก #defines มักจะขมวดคิ้วโดยโปรแกรมเมอร์ C ++ ส่วนใหญ่

และประการที่สามคุณบอกว่าคุณมีความแตกแยกในทีม ฉันเดาว่านี่หมายความว่าสมาชิกหลายคนได้ใช้แนวทางที่แตกต่างกันไปแล้วและคุณจำเป็นต้องสร้างมาตรฐาน การพิจารณาว่า#ifเป็นตัวเลือกที่ต้องการหมายความว่าโค้ดที่ใช้#ifdefจะคอมไพล์ - และรัน - แม้ว่าDEBUG_ENABLEDจะเป็นเท็จก็ตาม และง่ายกว่ามากในการติดตามและลบเอาต์พุตการดีบักที่สร้างขึ้นเมื่อไม่ควรจะเป็นในทางกลับกัน

โอ้และจุดอ่านเล็กน้อย คุณควรจะสามารถใช้ true / false แทนที่จะเป็น 0/1 ในของคุณ#defineและเนื่องจากค่าเป็นโทเค็นคำศัพท์เดียวจึงเป็นครั้งเดียวที่คุณไม่จำเป็นต้องมีวงเล็บล้อมรอบ

#define DEBUG_ENABLED true

แทน

#define DEBUG_ENABLED (1)

ทั้งคู่น่าเกลียด ให้ทำสิ่งนี้แทน:

#ifdef DEBUG
#define D(x) do { x } while(0)
#else
#define D(x) do { } while(0)
#endif

D();จากนั้นเมื่อใดก็ตามที่คุณจำเป็นต้องใช้รหัสแก้ปัญหาใส่ไว้ใน #ifdefและโปรแกรมของคุณจะไม่ถูกปนเปื้อนด้วยเขาวงกตที่น่าเกลียดของ

#ifdef เพียงตรวจสอบว่ามีการกำหนดโทเค็นหรือไม่

#define FOO 0

แล้ว

#ifdef FOO // is true
#if FOO // is false, because it evaluates to "#if 0"

เรามีปัญหาเดียวกันนี้ในหลายไฟล์และมักจะมีปัญหากับคนที่ลืมใส่ไฟล์ "แฟล็กฟีเจอร์" (ด้วย codebase> 41,000 ไฟล์จึงทำได้ง่าย)

หากคุณมี feature.h:

#ifndef FEATURE_H
#define FEATURE_H

// turn on cool new feature
#define COOL_FEATURE 1

#endif // FEATURE_H

แต่แล้วคุณลืมรวมไฟล์ส่วนหัวใน file.cpp:

#if COOL_FEATURE
    // definitely awesome stuff here...
#endif

จากนั้นคุณมีปัญหาคอมไพลเลอร์ตีความว่า COOL_FEATURE ไม่ได้กำหนดเป็น "เท็จ" ในกรณีนี้และไม่สามารถรวมโค้ดได้ ใช่ gcc รองรับแฟล็กที่ทำให้เกิดข้อผิดพลาดสำหรับมาโครที่ไม่ได้กำหนด ... แต่โค้ดของบุคคลที่สามส่วนใหญ่กำหนดหรือไม่ได้กำหนดคุณสมบัติดังนั้นนี่จะไม่ใช่แบบพกพา

เราได้ใช้วิธีการแก้ไขแบบพกพาสำหรับกรณีนี้รวมทั้งการทดสอบสถานะของคุณลักษณะ: ฟังก์ชันมาโคร

หากคุณเปลี่ยนคุณสมบัติข้างต้น h เป็น:

#ifndef FEATURE_H
#define FEATURE_H

// turn on cool new feature
#define COOL_FEATURE() 1

#endif // FEATURE_H

แต่แล้วคุณก็ลืมที่จะรวมไฟล์ส่วนหัวใน file.cpp อีกครั้ง:

#if COOL_FEATURE()
    // definitely awseome stuff here...
#endif

ตัวประมวลผลล่วงหน้าอาจผิดพลาดเนื่องจากการใช้มาโครฟังก์ชันที่ไม่ได้กำหนด

สำหรับวัตถุประสงค์ในการดำเนินการคอมไพล์ตามเงื่อนไข #if และ #ifdef นั้นเกือบจะเหมือนกัน แต่ก็ไม่มาก หากการคอมไพล์ตามเงื่อนไขของคุณขึ้นอยู่กับสองสัญลักษณ์ #ifdef ก็จะไม่ทำงานเช่นกัน ตัวอย่างเช่นสมมติว่าคุณมีสัญลักษณ์การคอมไพล์ตามเงื่อนไขสองแบบคือ PRO_VERSION และ TRIAL_VERSION คุณอาจมีสิ่งนี้:

#if defined(PRO_VERSION) && !defined(TRIAL_VERSION)
...
#else
...
#endif

การใช้ #ifdef ข้างต้นมีความซับซ้อนมากขึ้นโดยเฉพาะการทำให้ส่วน #else ทำงาน

ฉันทำงานกับโค้ดที่ใช้การคอมไพล์ตามเงื่อนไขอย่างกว้างขวางและเรามี #if & #ifdef ผสมกัน เรามักจะใช้ # ifdef / # ifndef สำหรับกรณีธรรมดาและ #if เมื่อใดก็ตามที่มีการประเมินสัญลักษณ์สองตัวขึ้นไป

ฉันคิดว่ามันเป็นคำถามเกี่ยวกับสไตล์โดยสิ้นเชิง ทั้งสองไม่มีข้อได้เปรียบที่ชัดเจนเหนือสิ่งอื่นใด

ความสม่ำเสมอมีความสำคัญมากกว่าทางเลือกใดทางเลือกหนึ่งดังนั้นฉันขอแนะนำให้คุณทำงานร่วมกับทีมของคุณและเลือกสไตล์เดียวและยึดติดกับมัน

ฉันชอบ:

#if defined(DEBUG_ENABLED)

เนื่องจากมันช่วยให้สร้างโค้ดที่มองหาเงื่อนไขตรงข้ามได้ง่ายขึ้นมาก:

#if !defined(DEBUG_ENABLED)

เทียบกับ

#ifndef(DEBUG_ENABLED)

มันเป็นเรื่องของสไตล์ แต่ฉันขอแนะนำวิธีที่กระชับกว่านี้:

#ifdef USE_DEBUG
#define debug_print printf
#else
#define debug_print
#endif

debug_print("i=%d\n", i);

คุณทำสิ่งนี้เพียงครั้งเดียวจากนั้นใช้ debug_print () เพื่อพิมพ์หรือไม่ทำอะไรเลย (ใช่สิ่งนี้จะรวบรวมในทั้งสองกรณี) ด้วยวิธีนี้รหัสของคุณจะไม่อ่านไม่ออกด้วยคำสั่งพรีโปรเซสเซอร์

หากคุณได้รับคำเตือน "นิพจน์ไม่มีผล" และต้องการกำจัดออกไปนี่เป็นทางเลือกอื่น:

void dummy(const char*, ...)
{}

#ifdef USE_DEBUG
#define debug_print printf
#else
#define debug_print dummy
#endif

debug_print("i=%d\n", i);

#ifให้คุณมีตัวเลือกในการตั้งค่าเป็น 0 เพื่อปิดฟังก์ชันการทำงานในขณะที่ยังตรวจพบว่ามีสวิตช์อยู่
โดยส่วนตัวแล้วฉันมัก#define DEBUG 1จะจับมันได้ด้วย #if หรือ #ifdef

#if และ # กำหนด MY_MACRO (0)

การใช้ #if หมายความว่าคุณได้สร้างมาโคร "กำหนด" นั่นคือสิ่งที่จะค้นหาในโค้ดที่จะถูกแทนที่ด้วย "(0)" นี่คือ "มาโครนรก" ที่ฉันไม่อยากเห็นใน C ++ เพราะมันทำให้โค้ดเสียหายด้วยการแก้ไขโค้ดที่อาจเกิดขึ้น

ตัวอย่างเช่น:

#define MY_MACRO (0)

int doSomething(int p_iValue)
{
   return p_iValue + 1 ;
}

int main(int argc, char **argv)
{
   int MY_MACRO = 25 ;
   doSomething(MY_MACRO) ;

   return 0;
}

ให้ข้อผิดพลาดต่อไปนี้ใน g ++:

main.cpp|408|error: lvalue required as left operand of assignment|
||=== Build finished: 1 errors, 0 warnings ===|

เพียงหนึ่งเดียวข้อผิดพลาด

ซึ่งหมายความว่าแมโครของคุณโต้ตอบกับรหัส C ++ ของคุณสำเร็จ: การเรียกใช้ฟังก์ชันสำเร็จ ในกรณีง่ายๆนี้มันน่าขบขัน แต่ประสบการณ์ของฉันเองกับการเล่นมาโครอย่างเงียบ ๆ ด้วยรหัสของฉันนั้นไม่ได้เต็มไปด้วยความสุขและความสมบูรณ์ดังนั้น ...

#ifdef และ #define MY_MACRO

การใช้ #ifdef หมายความว่าคุณ "กำหนด" บางอย่าง ไม่ใช่ว่าคุณให้ค่ามัน มันยังคงก่อมลพิษ แต่อย่างน้อยมันจะถูก "แทนที่ด้วยอะไร" และโค้ด C ++ จะไม่ถูกมองว่าเป็นคำสั่งรหัสที่ล้าสมัย รหัสเดียวกันด้านบนด้วยการกำหนดง่ายๆมัน:

#define MY_MACRO

int doSomething(int p_iValue)
{
   return p_iValue + 1 ;
}

int main(int argc, char **argv)
{
   int MY_MACRO = 25 ;
   doSomething(MY_MACRO) ;

   return 0;
}

ให้คำเตือนต่อไปนี้:

main.cpp||In function ‘int main(int, char**)’:|
main.cpp|406|error: expected unqualified-id before ‘=’ token|
main.cpp|399|error: too few arguments to function ‘int doSomething(int)’|
main.cpp|407|error: at this point in file|
||=== Build finished: 3 errors, 0 warnings ===|

ดังนั้น...

สรุป

ฉันอยากใช้ชีวิตโดยไม่มีมาโครในโค้ดของฉัน แต่ด้วยเหตุผลหลายประการ (การกำหนดส่วนป้องกันส่วนหัวหรือมาโครการแก้ไขข้อบกพร่อง) ฉันทำไม่ได้

แต่อย่างน้อยฉันต้องการให้พวกเขาโต้ตอบน้อยที่สุดเท่าที่จะเป็นไปได้ด้วยรหัส C ++ ที่ถูกต้องของฉัน ซึ่งหมายถึงการใช้ #define โดยไม่มีค่าโดยใช้ #ifdef และ #ifndef (หรือแม้กระทั่ง #if ที่กำหนดตามที่ Jim Buck แนะนำ) และที่สำคัญที่สุดคือการตั้งชื่อให้ยาวมากและคนต่างด้าวจะไม่มีใครในความคิดที่ถูกต้องของเขา / เธอใช้ "โดยบังเอิญ" และจะไม่มีผลต่อรหัส C ++ ที่ถูกต้องตามกฎหมาย

โพสต์ Scriptum

ตอนนี้ฉันกำลังอ่านโพสต์ของฉันอีกครั้งฉันสงสัยว่าฉันไม่ควรพยายามหาค่าบางอย่างที่ไม่เคยถูกต้อง C ++ เพื่อเพิ่มในการกำหนดของฉัน สิ่งที่ต้องการ

#define MY_MACRO @@@@@@@@@@@@@@@@@@

ที่สามารถใช้กับ #ifdef และ #ifndef ได้ แต่อย่าให้โค้ดคอมไพล์หากใช้ภายในฟังก์ชัน ... ฉันลองสิ่งนี้สำเร็จบน g ++ และทำให้เกิดข้อผิดพลาด:

main.cpp|410|error: stray ‘@’ in program|

น่าสนใจ. :-)

นั่นไม่ใช่เรื่องของสไตล์เลย นอกจากนี้คำถามยังไม่ถูกต้อง คุณไม่สามารถเปรียบเทียบคำสั่งพรีโปรเซสเซอร์เหล่านี้ในแง่ที่ดีกว่าหรือปลอดภัยกว่า

#ifdef macro

หมายถึง "ถ้ากำหนดมาโคร" หรือ "ถ้ามีมาโคร" ค่าของมาโครไม่สำคัญที่นี่ จะเป็นอย่างไรก็ได้

#if macro

ถ้าเปรียบเทียบกับค่าเสมอ ในตัวอย่างข้างต้นเป็นการเปรียบเทียบโดยนัยมาตรฐาน:

#if macro !=0

ตัวอย่างการใช้ #if

#if CFLAG_EDITION == 0
    return EDITION_FREE;
#elif CFLAG_EDITION == 1
    return EDITION_BASIC;
#else
    return EDITION_PRO;
#endif

ตอนนี้คุณสามารถใส่คำจำกัดความของ CFLAG_EDITION ในโค้ดของคุณได้

#define CFLAG_EDITION 1 

หรือคุณสามารถตั้งค่ามาโครเป็นแฟล็กคอมไพเลอร์ นอกจากนี้ยังดูที่นี่

ครั้งแรกดูเหมือนชัดเจนสำหรับฉัน ดูเหมือนเป็นธรรมชาติมากขึ้นทำให้เป็นแฟล็กเมื่อเทียบกับกำหนด / ไม่ได้กำหนดไว้

ทั้งสองเทียบเท่ากันทุกประการ ในการใช้สำนวน #ifdef จะใช้เพื่อตรวจสอบความถูกต้อง (และสิ่งที่ฉันจะใช้ในตัวอย่างของคุณ) ในขณะที่ #if ใช้ในนิพจน์ที่ซับซ้อนกว่าเช่น #if กำหนด (A) &&! กำหนด (B)

OT เล็กน้อย แต่การเปิด / ปิดการบันทึกด้วยตัวประมวลผลล่วงหน้านั้นเหมาะสมที่สุดใน C ++ มีเครื่องมือบันทึกที่ดีเช่นlog4cxxของ Apache ซึ่งเป็นโอเพ่นซอร์สและไม่ จำกัด วิธีการเผยแพร่แอปพลิเคชันของคุณ นอกจากนี้ยังช่วยให้คุณสามารถเปลี่ยนระดับการบันทึกโดยไม่ต้องคอมไพล์ใหม่มีค่าใช้จ่ายที่ต่ำมากหากคุณปิดการบันทึกและให้โอกาสคุณในการปิดการบันทึกอย่างสมบูรณ์ในการใช้งานจริง

ผมเคยใช้ #ifdefแต่เมื่อฉันเปลี่ยนไปใช้ Doxygen สำหรับเอกสารฉันพบว่ามาโครที่แสดงความคิดเห็นไม่สามารถจัดทำเป็นเอกสารได้ (หรืออย่างน้อย Doxygen ก็สร้างคำเตือน) ซึ่งหมายความว่าฉันไม่สามารถบันทึกมาโครการสลับคุณลักษณะที่ไม่ได้เปิดใช้งานอยู่ในขณะนี้

แม้ว่าจะเป็นไปได้ที่จะกำหนดมาโครสำหรับ Doxygen เท่านั้น แต่หมายความว่ามาโครในส่วนที่ไม่ใช้งานของโค้ดจะได้รับการจัดทำเป็นเอกสารด้วย โดยส่วนตัวฉันต้องการแสดงสวิตช์คุณสมบัติและทำเอกสารเฉพาะสิ่งที่เลือกไว้ในขณะนี้ นอกจากนี้ยังทำให้โค้ดค่อนข้างยุ่งหากมีมาโครจำนวนมากที่ต้องกำหนดเมื่อ Doxygen ประมวลผลไฟล์เท่านั้น

#ifดังนั้นในกรณีนี้มันจะดีกว่าเสมอกำหนดแมโครและการใช้งาน

ฉันใช้แฟล็ก #ifdef และคอมไพเลอร์เพื่อกำหนดเสมอ ...

หรือคุณสามารถประกาศค่าคงที่ส่วนกลางและใช้ C ++ if แทนตัวประมวลผลก่อน #if คอมไพเลอร์ควรปรับแต่งกิ่งก้านที่ไม่ได้ใช้ให้เหมาะสมสำหรับคุณและโค้ดของคุณจะสะอาดขึ้น

นี่คือสิ่งที่C ++ Gotchasโดย Stephen C.Dewhurst กล่าวเกี่ยวกับการใช้ # if's

มีความแตกต่างในกรณีของวิธีต่างๆในการระบุการกำหนดเงื่อนไขให้กับไดรเวอร์:

diff <( echo | g++ -DA= -dM -E - ) <( echo | g++ -DA -dM -E - )

เอาต์พุต:

344c344
< #define A 
---
> #define A 1

ซึ่งหมายความว่า-DAเป็นคำพ้องความหมาย-DA=1และหากละเว้นค่าอาจทำให้เกิดปัญหาในกรณี#if Aการใช้งาน

ฉันชอบ#define DEBUG_ENABLED (0)เวลาที่คุณอาจต้องการดีบักหลายระดับ ตัวอย่างเช่น:

#define DEBUG_RELEASE (0)
#define DEBUG_ERROR (1)
#define DEBUG_WARN (2)
#define DEBUG_MEM (3)
#ifndef DEBUG_LEVEL
#define DEBUG_LEVEL (DEBUG_RELEASE)
#endif
//...

//now not only
#if (DEBUG_LEVEL)
//...
#endif

//but also
#if (DEBUG_LEVEL >= DEBUG_MEM)
LOG("malloc'd %d bytes at %s:%d\n", size, __FILE__, __LINE__);
#endif

ทำให้การดีบักการรั่วไหลของหน่วยความจำง่ายขึ้นโดยไม่ต้องมีบรรทัดบันทึกทั้งหมดในการดีบักสิ่งอื่น ๆ

นอกจากนี้การ#ifndefกำหนดรอบ ๆ ยังทำให้ง่ายต่อการเลือกระดับการดีบักที่บรรทัดคำสั่ง:

make -DDEBUG_LEVEL=2
cmake -DDEBUG_LEVEL=2
etc

ถ้าไม่ใช่สำหรับสิ่งนี้ฉันจะให้ประโยชน์#ifdefเพราะแฟล็กคอมไพเลอร์ / make จะถูกแทนที่โดยแฟล็กในไฟล์ คุณจึงไม่ต้องกังวลกับการเปลี่ยนกลับส่วนหัวก่อนทำการคอมมิต