การเพิ่ม license ให้กับโปรเจ็คใน Netbeans

netbeans license header example
รูปตัวอย่าง license เมื่อสร้างไฟล์ php

ใน Netbeans นั้นเมื่อผู้พัฒนาสร้างไฟล์ใหม่ในโปรเจ็คที่กำลังพัฒนา จะสามารถกำหนด license และเครดิตต่างๆไว้บนส่วนหัวของไฟล์ได้อย่างง่ายๆ เพื่อแสดงว่างานนั้นๆมีการอนุญาตอย่างไร เขียนโดยใคร และอื่นๆอีกมากมาย

สร้างไฟล์ License

  1. ไปที่เมนู Tools > Templates
  2. คลิกที่ไอคอนสีเหลืองที่ชื่อ Licenses คลิกที่ Default License แล้วกดปุ่ม Duplicate จะได้ Default License 1
  3. คลิกที่ Default License 1 แล้วกดปุ่ม Rename
  4. กำหนดชื่อ โดย Template Display Name คือชื่อที่แสดงในกล่องรายการ Templates และ Template File Name คือชื่อไฟล์จริงๆที่จะ Save แล้วกด OK
  5. ในตัวอย่างนี้จะตั้งชื่อเป็น test_license สำหรับ Template Display Name และ license-test_license.txt สำหรับ Template File Name นะครับ

แก้ไขรายละเอียด License

คลิกที่ test_license แล้วกดปุ่ม Open in Editor
คัดลอกโค้ดตัวอย่างต่อไปนี้เพื่อนำไปใช้สร้าง license ตัวอย่าง


<#if licenseFirst??>
${licenseFirst}
</#if>
${licensePrefix}
${licensePrefix}PHP version 5
${licensePrefix}
${licensePrefix}@author ชื่อคุณ.
${licensePrefix}@license http://www.opensource.org/licenses/GPL-3.0
${licensePrefix}
<#if licenseLast??>
${licenseLast}
</#if>

จากโค้ดตัวอย่าง ${licenseFirst} คือส่วนแรกของตัวนำ license ในกรณี PHP ก็จะเป็น /** และ ${licenseLast} คือตัวปิดข้อมูล license ใน PHP ก็จะเป็น */
${licensePrefix} คือตัวอักษรนำหน้าของบรรทัดนั้นๆ ใน PHP จะเป็น *
รายการหัวข้อต่างๆของ PHP จะขึ้นต้นด้วย @ ซึ่งจะมีประโยชน์กรณีนำโค้ดไปสร้าง document กับตัว generator ต่างๆ
สำหรับรายละเอียด @ อื่นๆที่น่าสนใจโปรดอ่านต่อด้านล่างนะครับ ขอให้เสร็จตัวอย่างและทดลองได้ผลก่อน.

เมื่อแก้ไขเสร็จแล้ว ให้กด save เพื่อบันทึกไฟล์แล้วปิดไฟล์ template license นี้

กำหนด license ให้กับโปรเจ็ค

ใน 1 โปรเจ็คควรมี 1 license และเพื่อให้ Netbeans สร้างโค้ด license ให้อัตโนมัติเมื่อสร้างไฟล์ ให้ทำตามขั้นตอนต่อไปนี้.

netbeans files tab > project properties

  1. ที่หน้าต่าง Project explorer (โดยปกติอยู่ทางบนซ้าย) คลิกที่แทบ Files
  2. คลิกขยายไอคอนโฟลเดอร์ของโปรเจ็ค ที่ไม่ใช่ "- Source files"
  3. คลิกขยายจนกว่าจะเจอไฟล์ project.properties แล้วดับเบิลคลิกไฟล์นั้น
  4. มองหาบรรทัด project.license= หากไม่มีให้เพิ่มลงไปในบรรทัดล่าง แล้วกำหนดชื่อ Template Display Name ของ license ตัวอย่างที่เพิ่งสร้างขึ้น คือ test_license
    project.license=test_license
  5. กด Save ไฟล์แล้วปิดไฟล์ project.properties ได้เลย
  6. restart Netbeans 1 ครั้ง (ปิดแล้วเปิดใหม่)
  7. จากนั้นทดลองสร้างไฟล์ PHP ใหม่ในโปรเจ็คที่เพิ่งจะกำหนด property ลงไป
  8. ส่วนหัวของไฟล์ควรจะมีโค้ดต่อไปนี้อยู่ ก็ถือเป็นอันสำเร็จ


<?php
/**
*
* PHP version 5
*
* @author ชื่อคุณ.
* @license http://www.opensource.org/licenses/GPL-3.0
*
*/
?>

@document ที่น่าสนใจของ PHP

@author ชื่อผู้เขียน
@copyright กำหนดรายละเอียดของลิขสิทธิ์ของงาน
@deprecated กำหนดว่าไฟล์นี้จะเลิกใช้งานในเวอร์ชั่นอะไร พร้อมข้อมูลอธิบาย
@example กำหนด path/to/flie.php เพื่อแสดงไฟล์ตัวอย่างภายนอก
@license กำหนดการอนุญาต พร้อมทั้ง URL ของการอนุญาตนั้น เช่น GPL, MIT
@link กำหนด URL ให้กับเอกสารนั้น
@package กำหนดชื่อ package ของโปรเจ็คที่จะทำการแพ็ครวม
@since กำหนดว่าไฟล์นี้ตั้งแต่เวอร์ชั่นอะไร โดยเวอร์ชั่นอาจเป็นเวอร์ชั่นของโปรเจ็ค
@todo กำหนดสิ่งที่จะต้องทำในอนาคต
@version กำหนดเวอร์ชั่นของไฟล์และของโปรเจ็ค

ทั้งนี้รายการต่างๆยังมีอีกมาก เพียงแค่เปิด Netbeans พิมพ์ @ ลงใน comment ของ PHP ดังตัวอย่างต่อไปนี้


<?php
/**
*@
*/
?>

จากนั้นรายการ @document ต่างๆจะแสดงออกมาเป็น list ให้ผู้พัฒนาได้เลือกนำมาใช้ได้

 

ใส่ความเห็น

อีเมลของคุณจะไม่แสดงให้คนอื่นเห็น

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>