คำถามติดแท็ก naming

ปิด คำถามนี้เป็นคำถามความคิดเห็นตาม ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน5 ปีที่ผ่านมา ฉันกำลังพูดคุยกับอนุสัญญาการเข้ารหัสผู้พัฒนาระดับสูงเพื่อนำไปใช้กับโครงการของเรา (ส่วนใหญ่เป็นโครงการ Java / JEE) ฉันไม่เห็นด้วยกับการประชุมที่เขาเสนอ: ชื่อตัวแปรอินสแตนซ์ควรเริ่มต้นด้วย "_", ตัวแปรโลคอลด้วย "loc", และพารามิเตอร์เมธอดด้วย "par" ดังนั้นมันจะง่ายต่อการระบุที่มาและขอบเขตของตัวแปร ในขณะที่เขาหยิบยกข้อโต้แย้งสำหรับหน่วยความจำระยะสั้นและความสามารถในการอ่านฉันไม่เห็นด้วยกับความจริงที่ว่ามันค่อนข้างลดความสามารถในการอ่าน IDEs เช่นตัวแปรรูปแบบ Eclipse แตกต่างกันไปตามประเภทของพวกเขาและปัญหานี้ คุณมีความเห็นข้อโต้แย้งหรือการศึกษาที่สนับสนุนประเด็นของฉัน (หรือคัดค้าน) หรือไม่?

13 java  naming  variables 

ถ้าฉันมีต้นไม้ฉันจะ "แบน" โดยนัย รับรายการทั้งหมดในต้นไม้จากซ้ายไปขวา หากฉันมีรายการที่เชื่อมโยงจะ "แบน" โดยนัย รับรายการทั้งหมดเริ่มต้นด้วยรายการนี้ ตัวอย่างเช่นรายการที่เชื่อมโยงจะประกอบด้วยข้อยกเว้นที่รวมข้อยกเว้นภายใน มันจะยุติธรรมที่จะตั้งชื่อวิธีการในข้อยกเว้น "flattenInnerExceptions" ด้วยความคาดหวังว่ามันจะกลับลำดับของข้อยกเว้นข้อยกเว้นนอกสุดก่อนและข้อยกเว้นภายในสุด - ครั้งสุดท้าย?

13 naming 

ปิด. คำถามนี้เป็นคำถามปิดหัวข้อ ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้เป็นหัวข้อสำหรับ Software Engineering Stack Exchange ปิดให้บริการใน4 ปีที่แล้ว ในขณะที่การเข้ารหัสโครงการขนาดใหญ่ใน CI เกิดปัญหาขึ้น ถ้าฉันเขียนรหัสเพิ่มขึ้นเรื่อย ๆ มันจะมีเวลาที่ฉันจะจัดระเบียบรหัสได้ยาก ฉันหมายถึงว่าการตั้งชื่อสำหรับฟังก์ชั่นและตัวแปรสำหรับส่วนต่าง ๆ ของโปรแกรมอาจดูสับสน ดังนั้นฉันจึงคิดว่ามีแบบแผนการตั้งชื่อที่มีประโยชน์ที่ฉันสามารถใช้กับตัวแปร C และฟังก์ชั่นได้หรือไม่? ภาษาส่วนใหญ่แนะนำให้ใช้หลักการตั้งชื่อ แต่สำหรับ C สิ่งเดียวที่ฉันได้อ่านจนถึงตอนนี้คือชื่อควรเป็นคำอธิบายสำหรับการอ่านโค้ด แก้ไข: ตัวอย่างของตัวอย่างของแบบแผนการตั้งชื่อที่แนะนำ: Python PEP 8 สอน Java ฉันอ่านอนุสัญญาการตั้งชื่อเพิ่มเติมสำหรับ Java บางแห่ง แต่จำไม่ได้ว่าอยู่ที่ไหน

13 c  naming 

ฉันกำลังดิ้นรนเพื่อหาคำแนะนำในโลกแห่งความเป็นจริงในทางปฏิบัติเกี่ยวกับการตั้งชื่อฟังก์ชั่นสำหรับโครงการห้องสมุดซีขนาดกลาง โครงการห้องสมุดของฉันถูกแยกออกเป็นสองสามโมดูลและ submodules ด้วยส่วนหัวของพวกเขาเองและตามสไตล์ OO (ฟังก์ชั่นทั้งหมดใช้โครงสร้างที่แน่นอนว่าเป็นอาร์กิวเมนต์แรกไม่มี globals ฯลฯ ) มันเป็นสิ่งที่เราชอบ: MyLib - Foo - foo.h - foo_internal.h - some_foo_action.c - another_foo_action.c - Baz - baz.h - some_baz_action.c - Bar - bar.h - bar_internal.h - some_bar_action.c โดยทั่วไปฟังก์ชั่นนั้นใหญ่เกินกว่าจะยกตัวอย่างเช่นsome_foo_actionและanother_foo_actionในfoo.cไฟล์การนำไปใช้งานทำให้ฟังก์ชั่นส่วนใหญ่คงที่และเรียกมันว่าวัน ฉันสามารถจัดการกับการลอกสัญลักษณ์ภายใน ("โมดูลส่วนตัว") เมื่อสร้างห้องสมุดเพื่อหลีกเลี่ยงความขัดแย้งสำหรับผู้ใช้ของฉันด้วยโปรแกรมไคลเอนต์ของพวกเขา แต่คำถามคือวิธีตั้งชื่อสัญลักษณ์ในห้องสมุดของฉัน? จนถึงตอนนี้ฉันได้ทำ: struct MyLibFoo; void MyLibFooSomeAction(MyLibFoo *foo, ...); struct MyLibBar; void …

13 c  naming  project-structure 

ฉันสับสนเกี่ยวกับการเลือกชื่อสำหรับการทำงานของฉันในหลาม บางครั้งหลามในตัวฟังก์ชั่นที่มีความจำเป็นเช่นฟังก์ชั่นและวิธีสตริงprint findบางครั้งพวกเขาไม่ได้เช่นlenชื่อของมันไม่ได้เป็นความจำเป็นเช่นcalculate_lenตัวอย่างและไม่ได้เป็นtypefind_type ฉันสามารถเข้าใจว่าprintคืนค่าที่เราไม่ได้ใช้ (เช่นNone) และทำบางสิ่ง (เช่นมันจะแสดงสตริงบนหน้าจอ) ดังนั้นชื่อของมันจึงมีความจำเป็น แต่lenกลับเป็นค่าที่เราใช้และทำอะไรบางอย่าง (เช่นการคำนวณจำนวนรายการที่มีอยู่ในลำดับหรือการแมป.) และชื่อของมันไม่ได้เป็นความจำเป็น บนมืออื่น ๆ , findวิธีสตริง (เป็นlen) ส่งกลับค่าที่เราใช้และไม่บางสิ่งบางอย่างและชื่อของมันคือความจำเป็น สิ่งที่ทำให้คำถามนี้คือฉันใส่สคริปต์ที่เข้ารหัสและถอดรหัสสตริงโดยใช้ Caesar cipher เพื่อตรวจสอบ ผู้วิจารณ์กล่าวว่า: เป็นเพียงความรู้สึก: ฟังก์ชั่นทำสิ่งต่างๆ ดังนั้นชื่อที่ดีสำหรับการทำงานเป็นความจำเป็น: ฉันต้องการใช้แทนrotate_letterrotated_letter rotated_letterส่งคืนสตริงตัวอักษรเดี่ยวที่แทนตัวอักษรที่หมุนด้วยตัวเลข ผมไม่ทราบว่าสิ่งที่ดีกว่าที่ผมใช้rotated_letterเป็นมันจะกลับค่าเช่นrandintฟังก์ชั่นในโมดูลสุ่มgenerate_randintก็เป็นได้ ดังนั้นในกรณีนี้ฉันจะตั้งชื่อฟังก์ชันที่ส่งกลับค่าที่จะใช้อย่างไร ฉันควรจะให้ชื่อมีความจำเป็นหรือเพียงแค่เป็นรูปธรรม ในกรณีอื่น ๆ จะเห็นได้ชัดว่าจะทำอย่างไรเช่นฟังก์ชั่นบูลีนเช่นis_evenและis_palindromeเราก็ทำให้มันเหมือนคำถามใช่ / ไม่ใช่และฟังก์ชั่นที่เพิ่งทำและคืนค่าที่ไม่ได้ใช้ (เช่นNone), printและวิธีรายการsort.

13 python  naming  functions  naming-standards  python-3.x 

ปิด คำถามนี้เป็นคำถามความคิดเห็นตาม ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน5 ปีที่ผ่านมา เมื่อคุณกำหนดฟังก์ชั่น / ตัวแปร / ฯลฯ และไม่แน่ใจว่าจะตั้งชื่ออะไรคุณตั้งชื่ออะไร คุณสร้างชื่อขึ้นมาได้อย่างไร? หากคุณใช้ชื่อชั่วคราวเป็นบัตรสถานที่จนกว่าคุณจะให้มันเป็นชื่อจริงคุณใช้ชื่ออะไรชั่วคราว ปรับปรุง ฉันได้ใช้สิ่งที่ชอบWILL_NAME_LATER, หรือNEEDS_NAME TO_BE_NAMEDฉันหวังว่าจะมีการประชุมที่เป็นลูกบุญธรรมจริง ๆ แล้วฉันหวังว่าถ้าฉันใช้การประชุมที่นำมาใช้นี้ IDE ของฉันจะเน้นชื่อจนกว่าฉันจะเปลี่ยนมัน

13 naming  variables  functions 

ด้วยการทดสอบหน่วยโดเมนมีขนาดค่อนข้างเล็กดังนั้นจึงง่าย ฉันใช้methodName_conditions_result()รูปแบบของ Osherove และพบว่าชัดเจนมาก แต่ด้วยการทดสอบการรวมตัวฉันรู้สึกว่ามันจะทำให้ชื่อยาวมากและฉันจะแทนที่methodNameอะไร? ฉันจะตั้งชื่อคลาสทดสอบรวมได้อย่างไร ยินดีต้อนรับสู่ตัวอย่างการใช้งานจริงของชื่อการทดสอบการรวมระบบ ฉันหวังว่าคำตอบจะช่วยให้ฉันเข้าใจการทดสอบเหล่านี้ได้ดีขึ้น

13 testing  naming  integration-tests 

ในคำตอบของฉันฉันใช้_tเมื่อสิ้นสุดประเภทซึ่งจบลงอย่างดีที่สุดแย้ง นี่คือแนวทางปฏิบัติที่ฉันใช้ในโครงการปัจจุบันของฉัน typedef struct { int x; int y; } point_t; ครั้งนี้มีวัตถุประสงค์เพื่อให้สอดคล้องกับประเภท C จากstddef.hชอบหรือsize_t ptrdiff_tอย่างไรก็ตามตามความคิดเห็นบางอย่างในคำถามของฉัน_tpostfix ดูเหมือนจะถูกสงวนไว้สำหรับ POSIX ฉันควรใช้อะไรแทน_t? หรือฉันควรใช้_tต่อไปหรือไม่? คำถามนี้สำหรับทั้ง C และ C ++ หากภาษาเหล่านี้มีการประชุมที่แตกต่างกันอย่าลังเลที่จะตอบคำถาม

12 c++  c  naming 

ฉันกำลังสร้างแบบจำลองระบบเคมีและฉันมีปัญหากับการตั้งชื่อองค์ประกอบ / รายการของฉันภายใน Enum ฉันไม่แน่ใจว่าฉันควรใช้: สูตรอะตอม ชื่อทางเคมี ชื่อทางเคมีแบบย่อ ตัวอย่างเช่นกรดซัลฟูริกคือ H2SO4 และกรดไฮโดรคลอริกคือ HCl ด้วยสองอย่างนั้นฉันอาจจะใช้สูตรปรมาณูเนื่องจากมันเป็นเรื่องธรรมดา อย่างไรก็ตามฉันมีคนอื่น ๆ เช่นโซเดียม hexafluorosilicate ซึ่งก็คือ Na2SiF6 ในตัวอย่างที่สูตรอะตอมไม่เป็นที่เห็นได้ชัด (กับผม) myEnum.SodiumHexaFluoroSilicateแต่ชื่อทางเคมีคือน่ากลัวยาว: ฉันไม่แน่ใจว่าฉันจะสามารถสร้างชื่อทางเคมีอย่างย่อได้อย่างปลอดภัยซึ่งจะมีรูปแบบการตั้งชื่อที่สอดคล้องกันอย่างไร มีปัญหาสองสามข้อที่ฉันพยายามแก้ไขด้วยการตั้งชื่อองค์ประกอบ enum วิธีแรกคือความสามารถในการอ่านโดยมีชื่อยาวกว่าที่แสดงถึงปัญหา ข้อที่สองคือความง่ายในการหยิบรหัสสำหรับผู้ดูแลใหม่และที่นี่ชื่อที่สั้นกว่าจะแสดงปัญหา ปัญหาต่อไปคือเจ้าของธุรกิจมักจะอ้างถึงชื่อเคมีแบบเต็ม แต่ไม่เสมอไป สารเคมี "คำหนึ่ง" ถูกอ้างถึงโดยสูตรของพวกเขา ข้อกังวลสุดท้ายคือทำให้แน่ใจว่ามันสอดคล้องกัน ฉันไม่ต้องการใช้การตั้งชื่อแบบผสมเนื่องจากจะไม่สามารถจำได้ว่าควรใช้แบบใด จากมุมมองการบำรุงรักษาตัวเลือกการตั้งชื่อใดที่คุณต้องการดูและเพราะเหตุใด หมายเหตุ: ทุกอย่างที่นี่ด้านล่างบรรทัดเป็นส่วนเสริม | ชี้แจงวัสดุ โปรดอย่าจมดิ่งลงไป คำถามหลักเกี่ยวกับการตั้งชื่อวัตถุที่น่าอึดอัดใจ ตัวเลือกอะตอม สาธารณะ myEnum.ChemTypes { H2SO4, HCl, Na2SiF6 } ตัวเลือกชื่อเคมี …

12 naming  complexity 

ฉันมาจากพื้นหลัง Java และฉันใหม่กับ JavaScript ฉันสังเกตเห็นวิธีการจาวาสคริปต์หลายวิธีโดยใช้ชื่อพารามิเตอร์อักขระเดียวเช่นในตัวอย่างต่อไปนี้ doSomething(a,b,c) ฉันไม่ชอบ แต่นักพัฒนา JavaScript คนอื่นเชื่อฉันว่าสิ่งนี้ทำเพื่อลดขนาดไฟล์โดยสังเกตว่าไฟล์ JavaScript จะต้องถูกถ่ายโอนไปยังเบราว์เซอร์ จากนั้นฉันก็พบว่าตัวเองกำลังพูดคุยกับนักพัฒนาคนอื่น เขาแสดงให้ฉันเห็นวิธีที่ Firefox จะตัดทอนชื่อตัวแปรเพื่อโหลดหน้าเว็บเร็วขึ้น นี่เป็นวิธีปฏิบัติมาตรฐานสำหรับเว็บเบราว์เซอร์หรือไม่? การตั้งชื่อการแปลงแนวปฏิบัติที่ดีที่สุดที่ควรปฏิบัติเมื่อโปรแกรมใน JavaScript คืออะไร? ความยาวของตัวระบุสำคัญหรือไม่และถ้าเป็นเช่นนั้น

12 javascript  naming  coding-standards  conventions 

ปิด คำถามนี้เป็นคำถามความคิดเห็นตาม ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้สามารถตอบข้อเท็จจริงและการอ้างอิงได้โดยแก้ไขโพสต์นี้ ปิดให้บริการใน4 ปีที่แล้ว ฉันเห็นในหลาย ๆ ที่ที่ใช้คำResolveนี้ใน Dependency Injection (แก้ไขการใช้งานอินเทอร์เฟซ), Package Managers (เช่น: แก้ไขการพึ่งพาแพ็คเกจ), เว็บ (เช่น: แก้ไขชื่อโฮสต์) ดังนั้นสิ่งที่จะทำให้ตรรกะของรหัสพิเศษที่ทำให้คนเลือกคำResolveมากกว่าง่ายConvertหรือTransformหรือแม้กระทั่งGet?

12 programming-practices  naming  dependency-injection  packages 

สิ่งที่ใกล้เคียงที่สุดของ Golang ก็คือคู่มือสไตล์ที่พบได้ที่นี่ภายใต้ชื่อผู้รับข้อความที่เขียนนี้: ชื่อของวิธีการรับควรสะท้อนถึงตัวตนของมัน มักจะเป็นตัวย่อหนึ่งหรือสองตัวอักษรของประเภทพอเพียง (เช่น "c" หรือ "cl" สำหรับ "ลูกค้า") อย่าใช้ชื่อสามัญเช่น "ฉัน", "สิ่งนี้" หรือ "ตัวเอง", ตัวบ่งชี้ทั่วไปของภาษาเชิงวัตถุที่ให้ความสำคัญกับวิธีการที่ต่างจากฟังก์ชัน ชื่อไม่จำเป็นต้องมีความหมายเหมือนกับอาร์กิวเมนต์ของเมธอดเนื่องจากบทบาทนั้นชัดเจนและไม่มีวัตถุประสงค์ด้านเอกสาร โดยส่วนตัวฉันมักจะใช้ "นี่" เป็นตัวระบุเสมอเพราะ "นี่" คือจุดสำคัญของสิ่งที่ฉันกำลังทำงานเมื่อฉันเขียนและแก้ไขฟังก์ชั่น มันฟังดูดีและ (สำหรับฉันอย่างน้อย) มันสมเหตุสมผล หากชื่อนั้นไม่จำเป็นต้องอธิบายความหมายของบทบาทนั้นชัดเจนและไม่มีจุดประสงค์ในการทำสารคดีทำไมจึงต้องใช้ "เรื่องนี้" เพื่อขมวดคิ้ว?

12 coding-style  naming  golang 

ตัวอย่างเช่นฟังก์ชั่นต่อไปนี้ลูปผ่านอาร์เรย์ซึ่งมีชื่อและข้อผิดพลาดของช่องใส่ มันเป็นเช่นนี้โดยการตรวจสอบชื่อของเขตข้อมูลที่ตรวจสอบแล้วผลักดันข้อมูลข้อผิดพลาดไปยังอาร์เรย์ฟิลด์ที่ไม่ถูกต้อง ดีกว่าที่จะเป็นบทสรุปและเขียนนี้: addInvalidField (field, message) { const foundField = this.invalidFields.find(value => { return value.name === field.name }) const errors = foundField.errors if (!errors.some(error => error.name === message)) { errors.push({ name: message, message }) } }, หรือเฉพาะเจาะจงมากขึ้นเช่นนี้? addInvalidField (validatingField, message) { const foundField = this.invalidFields.find(invalidField => { return validatingField.name === …

11 coding-style  naming 

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

11 language-agnostic  naming  language-design  language-features 

ปิด. คำถามนี้เป็นคำถามปิดหัวข้อ ไม่ยอมรับคำตอบในขณะนี้ ต้องการปรับปรุงคำถามนี้หรือไม่ อัปเดตคำถามเพื่อให้เป็นหัวข้อสำหรับ Software Engineering Stack Exchange ปิดให้บริการใน8 ปีที่ผ่านมา คำสั่งการตั้งค่าภาษาเทมเพลต Velocityต้องการตัวแปรทางด้านซ้ายมือ มันใช้งานไม่ได้ #set ( $entries.add("d") ) แม้ว่าฉันจะไม่ได้ใช้สำหรับค่าตอบแทนของadd("d")ฉันต้องกำหนดให้ตัวแปร #set ( $x = $entries.add("d") ) ฉันต้องการสื่อสารว่าตัวแปรมีความจำเป็น แต่ฉันไม่ต้องการใช้ในภายหลัง มีแบบแผนสำหรับตัวแปรการตั้งชื่อที่มีอยู่เพื่อเอาใจคอมไพเลอร์เท่านั้น?

11 naming  syntax