Các quy ước chuẩn về code

Một phần của tài liệu Phát triển portlet mới cho người dùng ( BÀI TẬP LỚN CÔNG NGHỆ WEB VÀ DỊCH VỤ TRỰC TRUYẾN ) (Trang 57 - 59)

Phần 4: Một số vấn đề tham khảo 4 Các tags phổ biến trong portlet

4.2Các quy ước chuẩn về code

Một cách để tạo ra nội dung là copy, paste và update. Liferay portal là 1 framework hoàn chỉnh. Khi chúng ta đang phát triển 1 portlet tùy biến, chúng ta luôn luôn có thể sao chép các đoạn mã có sẵn trong các portlet khác, điều này giúp chúng ta tiết kiệm được nhiều thời gian.

Khi ta copy 1 đoạn code Liferay, ta đã vô tình tuân theo các quy tắc coding của Liferay, đây là 1 cách thực hành tốt. Tuân theo coding style của 1 Liferay code có sẵn.

Dưới đây là 1 số qui ước cho việc coding mà chúng ta có thể làm theo trong 1 Liferay portal project.

Đối với việc gọi trực tiếp file JSP, sử dụng phần mở rộng .jsp. Đối với việc các file JSP được bao gồm trong 1 file JSP khác, sử dụng phần mở rộng .jspf. Sau đây là ví dụ:

<%@ include file="/html/portlet/journal/ article_search_results.jspf" %>

Sử dụng dấu ngoặ đơn cho 1 các xâu trong JavaScript, như sau:

confirm('<%= UnicodeLanguageUtil.get(pageContext, "are-you-sure- you-want-to-delete-the-selected-feeds") %>')

Sử dụng fieldset để nhóm các trường đầu vào có liên quan đến nhau, như ví dụ sau:

<form action="..." method="post"> <fieldset class="orchardClass"> <legend>Orchard Fruits</legend>

<label for="<portlet:namespace />apple">Apple</label>

<input name="<portlet:namespace />apple" type="text" value="1" />

<label for="<portlet:namespace />orange">Orange</label>

<input name="<portlet:namespace />orange" type="text" value="2" />

<input type="submit" value="<liferay-ui:message key="pick" />" / >

</fieldset> </form>

Sử dụng các dấu phân cách có sẵn của Liferay để phân biệt các phần của từng loại khác nhau, như sau:

<div class="separator"><!-- --></div>

Nếu chúng ta tuân theo các quy ước coding, thì UI mà chúng ta tạo ra sẽ nhất quán hơn đối với các UI đã có sẵn của Liferay portal

Một phần của tài liệu Phát triển portlet mới cho người dùng ( BÀI TẬP LỚN CÔNG NGHỆ WEB VÀ DỊCH VỤ TRỰC TRUYẾN ) (Trang 57 - 59)