Sau <?php, mỗi file cần được bắt đầu bằng mô tả theo dạng
<?php /** * @Project NUKEVIET 4.x * @Author VINADES.,JSC (contact@vinades.vn) * @Copyright (C) 2014 VINADES.,JSC. All rights reserved * @License GNU/GPL version 2 or any later version * @Createdate Tue, 21 Jan 2014 01:32:02 GMT */ // Some code here
Trong đó:
<?php /** * @Project NUKEVIET 4.x * @Author VINADES.,JSC (contact@vinades.vn) * @Copyright (C) 2016 VINADES.,JSC. All rights reserved * @Language English * @License CC BY-SA (http://creativecommons.org/licenses/by-sa/4.0/) * @Createdate Mar 04, 2010, 08:22:00 AM */ // Some code here
Ta thêm thông tin ngôn ngữ Language bên dưới thông tin về bản quyền.
NukeViet áp dụng chuẩn định dạng code PSR-2, mọi quy các áp dụng có thể xem tại đó.
Xem bản dịch Tiếng Việt của tài liệu trên: https://github.com/nukeviet/fig-standards/blob/master/accepted/vi/PSR-2-coding-style-guide.md
Do chuẩn PSR-2 không có quy định cụ thể về cách viết array, do đó NukeViet áp dụng riêng chuẩn như sau: Nếu mảng ngắn từ một đến hai phần tử ta viết
$array = array('id' => $id, 'title' => $title);
Nếu dài hơn ta phải viết
$array = array( 'id' => $id, 'title' => $title );
Đối với mảng nhiều chiều ta viết
$array = array( 'id' => array( 'id' => $_id, 'content' => array( 'sub' => $sub, 'cat' => $cat ), ), 'title' => $title );
Áp dụng chuẩn viết tương tự php
Nếu không có trường hợp đặc biệt nên dùng duy nhất một tên main để dánh dấu khối
<!-- BEGIN: main -> <!-- END: main ->
Dùng loop để đánh dấu những khối lặp lại
<!-- BEGIN: main -> <ul> <!-- BEGIN: loop -> <li>The dinh dang kieu danh sach</li> <!-- END: loop -> </ul> <!-- END: main ->
Các file TPL thực chất chứa mã HTML, JS tương tự các file .html, cần dùng 4 ký tự space để đánh dấu các thẻ cha con:
<!-- BEGIN: main --> <div class="box-border"> <div class="page-header"> <h2>{CONTENT.title}</h2> <span class="small">{LANG.add_time}: {CONTENT.add_time}</span> <div class="clear"> </div> </div> <div class="content-box"> <div class="content-page"> {CONTENT.bodytext} </div> <!-- BEGIN: other --> <div class="other-news" style="border-top: 1px solid #d8d8d8;"> <ul style="margin:10px;"> <!-- BEGIN: loop --> <li> <a title="{OTHER.title}" href="{OTHER.link}">{OTHER.title}</a> </li> <!-- END: loop --> </ul> </div> <!-- END: other --> </div> </div> <!-- END: main -->
Các thẻ có nội dung ngắn nên để một dòng
<span>{DATA.infomation}</span>
Hạn chế tối đa viết trực tiếp CSS vào thẻ html.
Định dạng theo kiểu nhiều hàng.
.banner_plan { background: #FFF; border: 1px solid #DADADA; margin-bottom: 10px; padding: 5px }
Để định dạng code NukeViet trên Aptana Studio 3 bạn download file
fomat_aptana.zip cho Aptana Studio 3.4
fomat_aptana_3.6_nukeviet4.1.zip cho Aptana Studio 3.6.1
sau đó giải nén được file fomat_php.xml Import file định dạng
Vào menu Window → Preferences → Aptana→ Code Style → Formatter, kích vào nút Imprort và chọn tới file fomat_php.xml vừa giải nén
Cấu hình thêm để xóa các dòng trắng:
Sau khi lưu cấu hình, bạn mở từng file cần định dạng và nhấn tổ hợp phím Ctrl + Shift + F
Cấu hình Format cho PHP
eclipse_neon_3_nukeviet4_php.zip
Cấu hình Format cho JS
eclipse_neon_3_nukeviet4_js.zip
Để định dạng code NukeViet trên phpDesigner 8 bạn cầu hình fomat file php như sau:
Sau khi lưu cấu hình, bạn mở từng file cần định dạng và nhấn tổ hợp phím Shift + Ctrl + F1
Chú ý: PhpDesigner không định dạng tương tích hoàn toàn với chuẩn PSR-2 nên sau khi định dạng code theo trên, bạn cần thực hiện thêm hai thao tác nữa để có thể hoàn toàn áp dụng đúng chuẩn.
Catch (
nếu có, đưa nó lên ngang hàng với ký tự }
array(
và array (
nếu có kiểm tra lại và đưa ký tự đóng )
xuống hàng mới.Thiết lập cấu hình xóa khoảng trống khi lưu: