perlnewmod - ออนไลน์ในคลาวด์

โครงการ:

ชื่อ

perlnewmod - เตรียมโมดูลใหม่สำหรับการแจกจ่าย

DESCRIPTION

เอกสารนี้ให้คำแนะนำเกี่ยวกับวิธีการเขียนโมดูล Perl
เตรียมจำหน่ายและจำหน่ายผ่าน CPAN

สิ่งหนึ่งที่ทำให้ Perl มีประสิทธิภาพมากคือความจริงที่ว่าแฮกเกอร์ Perl มักจะ
อยากแชร์วิธีแก้ปัญหาที่เจอ จะได้ไม่ต้องทะเลาะกัน
กับปัญหาเดิมอีกแล้ว

วิธีหลักในการทำเช่นนี้คือการสรุปโซลูชันลงในโมดูล Perl ถ้าคุณไม่
รู้ว่าสิ่งเหล่านี้คืออะไร ส่วนที่เหลือของเอกสารนี้จะไม่เป็นประโยชน์กับคุณมากนัก
คุณยังพลาดโค้ดที่มีประโยชน์มากมาย พิจารณาดู perlmod
perlmodlib และ perlmodinstall ก่อนกลับมาที่นี่

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

คุณควรดู perlmodstyle สำหรับแนวทางปฏิบัติที่ดีที่สุดในการสร้างโมดูลด้วย

การเตือน
เราจะเน้นเฉพาะโมดูล Perl เท่านั้นที่นี่ มากกว่าโมดูล XS XS
โมดูลมีจุดประสงค์ที่แตกต่างออกไป และคุณควรพิจารณาสิ่งต่าง ๆ มาก่อน
แจกจ่ายพวกเขา - ความนิยมของห้องสมุดที่คุณติดกาว, การพกพาไปยังผู้อื่น
ระบบปฏิบัติการ เป็นต้น อย่างไรก็ตาม ข้อควรทราบในการจัดเตรียมด้าน Perl ของโมดูล
และบรรจุภัณฑ์และการจัดจำหน่ายจะใช้ได้ดีเท่าๆ กันกับโมดูล XS ที่เป็น Perl . บริสุทธิ์
หนึ่ง.

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

ลองมาดูตัวอย่างกัน สมมติว่าคุณกำลังอ่านข้อมูลจากรูปแบบโลคัลเป็นแฮชของ
แฮชใน Perl เปลี่ยนเป็นต้นไม้ เดินบนต้นไม้แล้ววางแต่ละโหนดไปที่ an
เซิร์ฟเวอร์ Acme Transmogrifier

ตอนนี้ มีคนจำนวนไม่น้อยที่มี Acme Transmogrifier และคุณต้องเขียนอะไรบางอย่างถึง
พูดถึงโปรโตคอลตั้งแต่ต้น - คุณเกือบจะต้องการทำให้มันเป็นโมดูล
ระดับที่คุณเสนอขายนั้นขึ้นอยู่กับคุณ: คุณอาจต้องการโมดูลระดับโปรโตคอล
คล้ายกับ Net::SMTP ซึ่งจะพูดคุยกับโมดูลระดับที่สูงกว่าซึ่งคล้ายกับ Mail::Send
ทางเลือกเป็นของคุณ แต่คุณต้องการนำโมดูลสำหรับโปรโตคอลเซิร์ฟเวอร์นั้นออก

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

หวังว่าตอนนี้คุณคงพอมีไอเดียบางอย่างเกี่ยวกับสิ่งที่ดีในการทำโมดูลาร์ มาดูกันเลย
มันทำอย่างไร

เป็นขั้นเป็นตอน: การเตรียม พื้นดิน
ก่อนที่เราจะเริ่มขูดโค้ด มีบางสิ่งที่เราต้องทำใน
ความก้าวหน้า

มองไปรอบ ๆ
เจาะลึกโมดูลต่างๆ เพื่อดูว่ามีการเขียนอย่างไร ฉันขอแนะนำให้เริ่มต้นด้วย
Text::Tabs เนื่องจากอยู่ในไลบรารีมาตรฐานและดูดีและดูเรียบง่าย
ในสิ่งที่ซับซ้อนกว่าเล็กน้อยเช่น File::Copy สำหรับโค้ดเชิงวัตถุ
โมดูล "WWW::Mechanize" หรือ "Email::*" ให้ตัวอย่างที่ดี

สิ่งเหล่านี้ควรให้ความรู้สึกโดยรวมเกี่ยวกับการจัดวางและเขียนโมดูลต่างๆ

เช็คของใหม่
มีโมดูลมากมายบน CPAN และง่ายต่อการพลาดโมดูลที่คล้ายกับอะไร
คุณกำลังวางแผนที่จะมีส่วนร่วม มีไถดีผ่าน
<http://search.cpan.org> และตรวจสอบให้แน่ใจว่าคุณไม่ใช่คนที่คิดค้นล้อใหม่!

อภิปรายความต้องการ
คุณอาจจะรักมัน คุณอาจรู้สึกว่าทุกคนต้องการมัน แต่คงไม่มี
ที่จริงแล้วเป็นความต้องการที่แท้จริงสำหรับมัน หากคุณไม่แน่ใจเกี่ยวกับความต้องการของคุณ
โมดูลจะมีให้พิจารณาส่งออกเครื่องสัมผัสใน "comp.lang.perl.modules"
กลุ่มข่าวหรือเป็นทางเลือกสุดท้าย ให้ถามรายชื่อโมดูลที่ "[ป้องกันอีเมล]". จดจำ
ว่านี่คือรายการปิดที่มีเวลาพลิกกลับนานมาก - เตรียมพร้อมรอ a
ดีในขณะที่สำหรับการตอบสนองจากพวกเขา

เลือกชื่อ
โมดูล Perl ที่รวมอยู่ใน CPAN มีลำดับชั้นการตั้งชื่อที่คุณควรพยายามปรับให้เหมาะสม
ดู perlmodlib สำหรับรายละเอียดเพิ่มเติมเกี่ยวกับวิธีการทำงาน และเรียกดู CPAN และ
รายการโมดูลเพื่อให้ได้ความรู้สึก อย่างน้อยที่สุด จำไว้ว่า: โมดูลควรเป็น
ชื่อตัวพิมพ์ใหญ่ (This::Thing) เข้ากับหมวดหมู่และอธิบายวัตถุประสงค์
รวบรัด

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

เมื่อคุณได้ชื่อของคุณแล้วและคุณแน่ใจว่าโมดูลของคุณเป็นที่ต้องการไม่ใช่
ได้เวลาเริ่มเขียนโค้ดแล้ว

เป็นขั้นเป็นตอน: การทำ โมดูล
เริ่มต้นด้วย โมดูลสตาร์ท or h2xs
เทศกาล โมดูลสตาร์ท ยูทิลิตี้ถูกแจกจ่ายเป็นส่วนหนึ่งของแพ็คเกจ Module::Starter CPAN
มันสร้างไดเร็กทอรีที่มีต้นขั้วของไฟล์ที่จำเป็นทั้งหมดเพื่อเริ่มโมดูลใหม่
ตาม "แนวปฏิบัติที่ดีที่สุด" ล่าสุดสำหรับการพัฒนาโมดูลและถูกเรียกใช้จาก
บรรทัดคำสั่งดังนี้:

โมดูลเริ่มต้น --module=Foo::Bar \
--author="ชื่อของคุณ" --email=[ป้องกันอีเมล]

หากคุณไม่ต้องการติดตั้งแพ็คเกจ Module::Starter จาก CPAN h2xs แก่กว่า
เครื่องมือ เดิมทีมีไว้สำหรับการพัฒนาโมดูล XS ซึ่งมาพร้อมกับ
การกระจาย Perl

การเรียกใช้ h2xs โดยทั่วไปสำหรับโมดูล Perl ล้วนคือ:

h2xs -AX --skip-exporter --use-new-tests -n Foo::Bar

"-A" ละเว้นรหัส Autoloader, "-X" ละเว้นองค์ประกอบ XS, "--skip-exporter" ละเว้น
รหัสผู้ส่งออก "--use-new-tests" ตั้งค่าสภาพแวดล้อมการทดสอบที่ทันสมัย ​​และ "-n"
ระบุชื่อของโมดูล

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

ใช้ปลาคาร์พ
โมดูล Carp ช่วยให้คุณสามารถนำเสนอข้อความแสดงข้อผิดพลาดจากผู้โทร
ทัศนคติ; วิธีนี้จะช่วยให้คุณส่งสัญญาณปัญหากับผู้โทรได้ ไม่ใช่ของคุณ
โมดูล. ตัวอย่างเช่น ถ้าคุณพูดแบบนี้:

เตือน "ไม่ได้ระบุชื่อโฮสต์";

ผู้ใช้จะเห็นสิ่งนี้:

ไม่มีชื่อโฮสต์ที่ /usr/local/lib/perl5/site_perl/5.6.0/Net/Acme.pm
สาย 123.

ซึ่งดูเหมือนว่าโมดูลของคุณกำลังทำอะไรผิดพลาด คุณต้องการใส่
ตำหนิผู้ใช้และพูดแบบนี้:

ไม่มีการระบุชื่อโฮสต์ที่ bad_code บรรทัดที่ 10

คุณทำได้โดยใช้ Carp และแทนที่ "warn" ด้วย "carp" หากคุณต้องการ
"ตาย" ให้พูดว่า "บ่น" แทน อย่างไรก็ตาม ให้ "เตือน" และ "ตาย" ไว้สำหรับสุขภาพจิตของคุณ
ตรวจสอบ - โมดูลของคุณมีข้อผิดพลาดตรงไหน

ใช้ผู้ส่งออก - อย่างชาญฉลาด!
ผู้ส่งออกให้วิธีมาตรฐานในการส่งออกสัญลักษณ์และรูทีนย่อยจากโมดูลของคุณ
ลงในเนมสเปซของผู้โทร ตัวอย่างเช่น การพูดว่า "use Net::Acme qw(&frob)" จะ
นำเข้ารูทีนย่อย "frob"

ตัวแปรแพ็คเกจ @EXPORT จะกำหนดสัญลักษณ์ที่จะส่งออกเมื่อ
ผู้โทรเพียงแค่พูดว่า "ใช้ Net::Acme" - คุณแทบจะไม่ต้องการใส่อะไรเลย
ที่นั่น. ในทางกลับกัน @EXPORT_OK จะระบุสัญลักษณ์ที่คุณต้องการส่งออก
หากคุณต้องการส่งออกสัญลักษณ์จำนวนมาก ให้ใช้ %EXPORT_TAGS และกำหนดมาตรฐาน
ชุดส่งออก - ดูรายละเอียดเพิ่มเติมที่ผู้ส่งออก

ใช้เอกสารเก่าธรรมดา
งานยังไม่จบ จนกว่าเอกสารจะเสร็จ และคุณจะต้องใส่
ใช้เวลาในการเขียนเอกสารสำหรับโมดูลของคุณ "module-starter" หรือ "h2xs" will
จัดเตรียมต้นขั้วให้คุณกรอก หากคุณไม่แน่ใจเกี่ยวกับรูปแบบ ให้ดูที่ perlpod
เพื่อเป็นการแนะนำ ให้ข้อมูลสรุปที่ดีเกี่ยวกับวิธีการใช้โมดูลของคุณในโค้ด a
คำอธิบายแล้วบันทึกเกี่ยวกับไวยากรณ์และหน้าที่ของรูทีนย่อยแต่ละรายการหรือ
วิธีการ ใช้ความคิดเห็น Perl สำหรับบันทึกของนักพัฒนาและ POD สำหรับบันทึกของผู้ใช้ปลายทาง

เขียนแบบทดสอบ
ขอแนะนำให้คุณสร้างการทดสอบตัวเองสำหรับโมดูลของคุณเพื่อให้แน่ใจว่าทำงานเป็น
ตั้งใจไว้บนแพลตฟอร์มมากมายที่ Perl รองรับ; หากคุณอัปโหลดโมดูลของคุณไปที่ CPAN a
โฮสต์ของผู้ทดสอบจะสร้างโมดูลของคุณและส่งผลการทดสอบให้คุณ อีกครั้ง,
"module-starter" และ "h2xs" จัดเตรียมกรอบการทดสอบที่คุณสามารถขยายได้ - คุณควร
ทำอะไรมากกว่าการตรวจสอบโมดูลของคุณจะคอมไพล์ ทดสอบ::ง่ายและ
การทดสอบ :: จุดเริ่มต้นที่ดีในการเขียนชุดทดสอบคือจุดเริ่มต้นที่ดี

เขียน README
หากคุณกำลังอัปโหลดไปยัง CPAN โปรแกรม Gremlins อัตโนมัติจะแตกไฟล์ README และ
วางไว้ในไดเร็กทอรี CPAN ของคุณ มันจะปรากฏในหลัก .ด้วย โดยโมดูล และ โดย -
หมวดหมู่ ไดเร็กทอรีหากคุณสร้างลงในรายการโมดูล เป็นความคิดที่ดีที่จะใส่ที่นี่
รายละเอียดสิ่งที่โมดูลทำจริง ๆ และการเปลี่ยนแปลงที่ผู้ใช้มองเห็นได้ตั้งแต่ครั้งล่าสุด
ปล่อย

เป็นขั้นเป็นตอน: กระจาย ธุรกิจ โมดูล
รับ ID ผู้ใช้ CPAN
โมดูลการเผยแพร่นักพัฒนาทุกคนบน CPAN ต้องมี CPAN ID เยี่ยม
"http://pause.perl.org/" เลือก "ขอหยุดบัญชีชั่วคราว" และรอคำขอของคุณไปที่
ได้รับการอนุมัติจากผู้ดูแลระบบ PAUSE

"perl Makefile.PL ทำการทดสอบ ทำ dist"
เป็นอีกครั้งที่ "module-starter" หรือ "h2xs" ทำทุกอย่างให้คุณแล้ว พวกเขาผลิต
มาตรฐาน "Makefile.PL" คุณจะเห็นเมื่อคุณดาวน์โหลดและติดตั้งโมดูล และสิ่งนี้จะทำให้เกิด
Makefile ที่มีเป้าหมาย "dist"

เมื่อคุณแน่ใจว่าโมดูลของคุณผ่านการทดสอบแล้ว - เป็นสิ่งที่ดีที่จะทำเสมอ
แน่นอน - คุณสามารถ "สร้าง dist" และ Makefile หวังว่าจะสร้าง tarball ที่ดีให้คุณ
ของโมดูลของคุณ พร้อมสำหรับการอัปโหลด

อัพโหลด tarball
อีเมลที่คุณได้รับเมื่อได้รับ CPAN ID จะบอกวิธีลงชื่อเข้าใช้ PAUSE
เซิร์ฟเวอร์อัพโหลด Perl Authors จากเมนูที่นั่น คุณสามารถอัปโหลดโมดูลของคุณไปที่
ซีพีเอ็น.

ประกาศรายชื่อโมดูล
เมื่ออัปโหลดแล้ว จะไม่มีใครสังเกตเห็นในไดเร็กทอรีผู้เขียนของคุณ หากคุณต้องการเชื่อมต่อ
สำหรับส่วนที่เหลือของ CPAN คุณจะต้องไปที่ "ลงทะเบียนเนมสเปซ" ใน PAUSE ครั้งหนึ่ง
ลงทะเบียนแล้ว โมดูลของคุณจะปรากฏในรายการตามโมดูลและตามหมวดหมู่บน CPAN

ประกาศ clpa
หากคุณมีความปรารถนาอย่างแรงกล้าที่จะบอกให้โลกรู้เกี่ยวกับการปล่อยตัวของคุณ ให้โพสต์ประกาศ
ไปยังกลุ่มข่าว "comp.lang.perl.announce" ที่ผ่านการกลั่นกรอง

แก้ไขข้อบกพร่อง!
เมื่อคุณเริ่มรวบรวมผู้ใช้ พวกเขาจะส่งรายงานข้อบกพร่องให้คุณ หากคุณโชคดี
พวกเขายังส่งแพตช์ให้คุณด้วย ยินดีต้อนรับสู่ความสุขในการดูแลโครงการซอฟต์แวร์...

ใช้ perlnewmod ออนไลน์โดยใช้บริการ onworks.net