top
 0982.566.782
Thiet ke web hai phong chuyen nghiep
Thiết kế website, quảng cáo trực tuyến, xây dựng phần mềm, dịch vụ domain-hosting

Thiết kế web - Chuẩn viết mã lệnh cho ASP.NET (Phần 1)

Ngày đăng: 22 - 08 - 2011

Thiết kế web - Chuẩn viết mã lệnh cho ASP.NET (Phần 1) Giới thiệu chuẩn viết mã lệnh cho thiết kế web với ASP.NET

Đăng bởi: Thiết kế web Hải Phòng - HPSOFT 

 

0.1 Tổng quan

Bộ khung ứng dụng Microsoft .NET Framework là một nền tảng lớn để phát triển các loại phần mềm ứng dụng ngày càng có xu hướng: qui mô lớn, phức tạp và phân tán

Net Framework được xây dựng trên cơ sở của một hệ lập trình thống nhất. nhằm đảm bảo cho việc phát triển các hệ thống phần mềm có tính nhất quán, khả năng tái sử dụng các thành phần phần mềm được xây dựng từ các công cụ, ngôn ngữ lập trình khác nhau

0.1.1 Kiến trúc hạ tầng của bộ khung ứng dụng Ms .NET .

0.1.2 Mối quan hệ giữa Hệ kiểu chung (CTS – Common Type System) và Đặc tả ngôn ngữ chung (CLS – Common Language Specification)

0.1.3 Mục đích của tài liệu

Tài liệu này bao gồm một tập các quy tắc chung cho việc xây dựng và viết mã lệnh tuân theo chuẩn xây dựng phần mềm dựa trên công nghệ .NET, được thu thập từ các đặc tả mà hãng Microsoft khuyến nghị cho cộng đồng các nhà phát triển ứng dụng trên nền tảng .NET.

 

Tài liệu nhằm đảm bảo các tiêu chí sau:

0.1.4 Tổ chức tài liệu

 0.1 Các phong cách đặt tên

Có 3 phong cách đặt tên trong chuẩn .NET

 

1. Kiểu Pascal: Trong kiểu đặt tên này, mỗi định danh được đặt tên với chữ cái đầu tiên của mỗi từ là chữ hoa

            Ví dụ: Portal, PortalSettings, ..

 

2. Kiểu Camel: Trong kiểu đặt tên này, mỗi định danh được đặt tên với chữ các đầu tiên là chữ thường, các chữ cái đầu khác ở các từ kế tiếp (nếu có) là dạng chữ hoa

            Ví dụ: connection, connectionString, ..

 

3. Kiếu chữ viết hoa (Uppercase): Trong kiểu đặt tên này, mỗi định danh được đặt tên với tất cả các chữ trong từ là chữ hoa, các từ phân cách nhau bằng dấu gạch nối

            Ví dụ: IO, MESSAGEBOX_OK, DB_CONNECTION, ..

 

Tất cả các thực thể trong các chương trình .NET (Biến, Class, Namespace, Method, Property, ..) đều được qui ước đặt tên ở một trong 3 phong cách này

 

0.2 Qui ước sử dụng chữ hoa, chữ thường trong các CT

Để đảm bảo được tính tương thích trong khi sử dụng lai các thành phần phần mềm được xây dựng từ các công cụ, ngôn ngữ lập trình (NNLT) khác nhau , ta nên tuân theo các qui tắc sau:

  • Không nên tạo hai Namespace với tên khác nhau chỉ chữ với chữ hoa, chữ thường:

Ví dụ: Hpsoft.Web và hpsoft.web

 

  • Không đặt tên hai đối số của một hàm chỉ khác nhau chữ hoa, chữ thường

Ví dụ: void Add(int A, int a)

 

  • Không đặt tên 2 hàm (phương thức) khác nhau chỉ chữ hoa, chữ thường

Ví dụ:

      void Add(int x, int y) , và

      void add(int x, int y)

 

0.3 Sử dụng các từ viết tắt

-    Không sử dụng các chữ viết tắt khi thuật ngữ sử dụng là không phổ biến:

                        Ví dụ:

Nên viết GetWindow thay vì GetWin

Nên viết System thay vì Sys

 

  • Sử dụng các chữ viết tắt khi thích hợp với các thuật ngữ được chấp nhận rộng rãi

Ví dụ:

UI  thay vì UserInterface

OLAP thay vì Online Analytical Processing

 

0.4 Lựa chọn các từ để đặt tên

-    Cần lựa chọn các từ sao cho nó phản ánh đúng ngữ nghĩa của đối tượng mà nó         

      mô tả

            Ví dụ:

                        int customerNo = GetCustomerNo(customerId)

                        Customer customer = GetCustomer(customerId)

            thay vì:

                        int i = GetCustomerNo(customerId)

                        Customer c = GetCustomer(customerId)

 

  • Tránh đặt tên các đối tượng trùng với các từ khoá trong ngôn ngữ các ngôn ngữ lập trình (Tham khảo bảng các từ khoá để biết chi tiết)

 

 

0.5 Qui ước đặt tên Không gian tên (Namespace)

-     Các namespace nên được đặt tên sử dụng ký pháp Pascal (xem phần trên), qui   

       ước chung  để đặt tên cho các  namespace như sau:

            [Tên công ty].[Tên Công nghệ].[Đặc trưng].[Thiết kế]

       Ví dụ:

            Microsoft.Win32

            System.Web.UI

            System.Web.UI.Design

 

0.6 Qui ước đặt tên Lớp (Class)

-     Các lớp được đặt tên theo ký pháp Pascal sử dụng các danh từ hoặc cụm danh   

       từ

                   Ví dụ:

                        Customer, CustomerAccount

 

0.7 Qui ước đặt tên Giao diện (Interface)

-     Các giao ký pháp Pascal sử dụng các danh từ hoặc cụm danh từ, hoặc tính từ        

      dùng để mô tả hành vi, mỗi giao diện có ký tự tiền tố là chữ I hoa

      Ví dụ:

            IEnumerator,   IReader,  hay IDisposable, ISerializable

0.8 Qui ước đặt tên cho Kiểu dữ liệu liệt kê (Enum)

-     Sử dụng ký pháp Pascal cho cả tên kiểu và các giá trị của kiểu

                   Ví dụ:

                        enum Mua

                        {

                                    Xuan, Ha, Thu, Dong

}                                

0.9 Qui ước đặt tên Đối số của hàm – phương thức (Parameter)

            -     Sử dụng ký pháp Camel để đặt tên cho các đối số của hàm (phương thức)

                   Ví dụ:

                        void UpdateUser(int userId, string username, string password)                   

 

0.10 Qui ước đặt tên cho hàm – phương thức (Func - Method)

            -      Sử dụng ký pháp Pascal để đặt tên cho các hàm (phương thức)

                    Ví dụ:

                        void UpdateUser(int userId, string username, string password)

                        UserInfo GetUser(int userId)            

0.11 Qui ước đặt tên cho các Thuộc tính (Property)

-      Sử dụng danh từ hoặc cụm danh từ, ký pháp Pascal để đặt tên cho các thuộc      

        tính         

        Ví dụ: (VB .NET)

            Public Class User

                        Private _username As String ‘ VB .NET phân biệt chữ hoa, chữ 

                        Private _password As String ‘ thường nên hay đặt tên dữ liệu thành

                                                                       ‘ phần với tiền tố là ký tự _

           

                        Public Property Username() As String

                                    Get

                                                Return _username

                                    End Get

                                    Set

                                                _username = Value

                                    End Set

                        End  Property

 

                        Public Property Password() As String

                                    Get

                                                Return _password

                                    End Get

                                    Set

                                                _password = Value

                                    End Set

                        End  Property

            End Class                   

 

        Ví dụ: (C# )

            public class User

            {

                        private string username;

                        private string password;

 

                        public string Username

                        {

                                    get { return username; }

                                    set { username = value; }

}

 

public string Password

{

            get { return password; }

            set { password = value; }

}

}

 

 

0.12 Qui ước đặt tên biến thành phần lớp (Datamember, fields)

Các biến thành phần bị che dấu đối với các thành phần truy cập từ bên ngoài lớp, (theo nguyên lý bao gói và che dấu thông tin trong LTHĐT), do đó việc đặt tên cho các thành phần này khá thoải mái. Tuy nhiên, để chuẩn hoá, trong thực hành người ta thường sử dụng các ký pháp sau (Tuỳ thuộc vào ngôn ngữ lập trình được sử dụng)

 

Với lớp User được định nghĩa ở trên, ta có thể đặt tên cho các biến thành phần như sau (tuỳ theo ngôn ngữ)

 

Với VB.NET có thể đặt tên như sau:

            Private _username As String      ‘ Sử dụng dấu gạch nối trước tên

            Private m_Username As String ‘ Sử dụng ký pháp của VC++

           

Với C# có thể đặt tên như sau:

            private string username;             ‘ Chuẩn theo C#

            private string _username;           ‘ Hay được sử dụng 

            private string m_username         ‘ Hay được người lập trình VC++ sử dụng

 

0.13 Qui ước đặt tên cho các biến Sự kiện

Các sự kiện trong .NET được xây dựng dựa trên mô hình delegate. Theo qui ước, mỗi kiểu dữ liệu sự kiện đều được đặt tên với phần hậu tố là EventHandler. Còn tên của đối số sự kiện luôn được đặt với phần hậu tố là EventArgs

 

Nguyên mẫu của delegate mô tả sự kiện như sau:

[Kiểu trả về] [Tên delegate] (object sender, EventArgs e)

 

Hai đối số của sự kiện gồm:

1. sender: luôn có kiểu là object

2. e: Luôn có kiểu EventArgs hoặc kiểu dẫn xuất từ nó

            Ví dụ sau định nghĩa lớp Mouse và các khai váo sự kiện gắn với nó:

 

            namespace MouseWithEventExample   

            {

                        // Khai báo delegate cho phép xử lý các sự kiện phát sinh từ lớp Mouse

                        delegate void MouseEventHandler(object sender, MouseEventArgs e);

                       

                        // Định nghĩa lớp Mouse

                        public class Mouse

                        {

                                    private int x; // Tọa độ ngang của chuột

                                    private int y; // Toạ độ dọc của chuột

 

                                    // Thành phần kiểu sự kiện phát sinh từ Mouse

// khi người dùng kích chuột (Hậu tố nên là EventHandler)

                                    public event MouseEventHandler Clicked;

 

                                    // Hàm phát sinh sự kiện kích chuột với các tham

                                    // số ghi lại vị trí tọa độ (x, y)

                                    protected void RaiseClickEvent()

                                    {

                                                if (Clicked != null)

                                                {                                                                                                                                                          // Ghi lại vị trí tọa độ (x, y) và truyền vào

                                                            // tham số sự kiện

                                                            MouseEventArgs e = new MouseEventArgs();         

                                                            e.X = this.x;

                                                            e.Y = this.y;                                       

                                                            Clicked(this, e);          

}

                                    }

 

                                    // Lớp khai báo tham số sự kiện cho Mouse

                                    // (Luôn thừa kế từ lớp System.EventArgs)

// (Hậu tố nên là EventArgs)

                                    public class MouseEventArgs : System.EventArgs

                                    {

                                                private int x;

                                                private int y;

 

                                                public MouseEventArgs()

                                                {

}

 

public MouseEventArgs(int x, int y)

{

            this.x = x;

            this.y = y;

}

 

public int X

{

            get { return x; }

            set { x = value; }

}

 

                                                public int Y

{

            get { return y; }

            set { y = value; }

}

}

}

}




Chia sẻ
Share on Facebook


.: Các tin thiết kế web khác :.

thiet ke web Hai Phong123

Tư vấn thiết kế web
Thiet ke web Hai Phong ho tro
Tư vần thiết kế website, hỗ trợ trực tuyến

     Hotline: 0982.566.782

   Kinh Doanh     Thiet ke website Hai Phong yahoo   Thiết kế web Hải Phòng Skype     Email tu van thiet ke web




Khách hàng nói về chúng tôi
Công ty thiết kế web Hải Phòng

CEO Nguyễn Văn Công

Công ty TNHH TMDV Trường Hưng. Tel: 0936 847 357

CEO Hà Thị Thanh Xuân

Công ty TNHH Cửa Cuốn Đại Phúc. Tel: 0912.665.189

CEO Tạ Thị Hương

Công ty In Phi Long. Tel: 0936.434.222

CEO Nguyễn Tuấn Dũng

Chủ tịch hệ thống Yoga Vàng Việt Nam. Tel: 0968.25.6868