주석의 머리

3087 단어

Function Headers
Each function in the source code must have a function header of the following format:-
1) Web Page, Web Control
<%-********************************************************************************
* Copyright(C) 2011 company Asia Pacific Pte Ltd
*
* FUNCTION : Function_Name
* DESCRIPTION : Function purpose and operation - including what it alters
* PARAMETERS : Type Name Description
* RETURN : Type Values Description
* CREATED DATE/BY : baseline date / developer
*
* REVISION HISTORY:
* DATE/BY SR#/CS/PM#/OTHERS DESCRIPTION OF CHANGE
*
********************************************************************************--%>
e.g.
<%--**********************************************************************************
* Copyright(C) 2011 company Asia Pacific Pte Ltd
*
* FUNCTION : SPLogin.aspx
* DESCRIPTION : Login page
* PARAMETERS :
* RETURN :
* CREATED DATE/BY : 27 July 2011 / OHH
*
* REVISION HISTORY:
* DATE/BY SR#/CS/PM#/OTHERS DESCRIPTION OF CHANGE
*
***********************************************************************************--%>
Page 2 of 4
2) Stored Procedure, Function
-- ********************************************************************************
-- Copyright(C) 2011 company  Asia Pacific Pte Ltd
--
-- FUNCTION : Function_Name
-- DESCRIPTION : Function purpose and operation - including what it alters
-- PARAMETERS : Type Name Description
-- RETURN : Type Values Description
-- CREATED DATE/BY : baseline date / developer
--
-- REVISION HISTORY:
-- DATE/BY SR#/CS/PM#/OTHERS DESCRIPTION OF CHANGE
--
-- ********************************************************************************
e.g.
-- ********************************************************************************
-- Copyright(C) 2011 company Asia Pacific Pte Ltd
--
-- FUNCTION : SPLogin.aspx.cs
-- DESCRIPTION : Login page
-- PARAMETERS :
-- RETURN :
-- CREATED DATE/BY : 27 July 2011 / OHH
--
-- REVISION HISTORY:
-- DATE/BY SR#/CS/PM#/OTHERS DESCRIPTION OF CHANGE
--
-- ********************************************************************************
Page 3 of 4
3) C# Code Behind
/**********************************************************************************
* Copyright(C) 2011 company Asia Pacific Pte Ltd
*
* FUNCTION : Function_Name
* DESCRIPTION : Function purpose and operation - including what it alters
* PARAMETERS : Type Name Description
* RETURN : Type Values Description
* CREATED DATE/BY : baseline date / developer
*
* REVISION HISTORY:
* DATE/BY SR#/CS/PM#/OTHERS DESCRIPTION OF CHANGE
*
**********************************************************************************/
e.g.
/**********************************************************************************
* Copyright(C) 2011 company Asia Pacific Pte Ltd
*
* FUNCTION : SPLogin.aspx.cs
* DESCRIPTION : Login page
* PARAMETERS :
* RETURN :
* CREATED DATE/BY : 27 July 2011 / OHH
*
* REVISION HISTORY:
* DATE/BY SR#/CS/PM#/OTHERS DESCRIPTION OF CHANGE
*
**********************************************************************************/


좋은 웹페이지 즐겨찾기