استفاده از کامنت ها در یک SQL Server stored procedure

استفاده از کامنت ها در یک SQL Server stored procedure

کار ساده ای که انجام آن با stored procedures موثر خواهد بود، افزودن کامنت ها به کد می باشد. این به شما کمک می کند تا بدانید که چه کاری و چرا انجام شده و همچنین به دیگر DBAها و توسعه دهنده ها کمک می کند تا اگر لازم است اصلاحاتی روی کد انجام دهند.

SQL Server در یک stored procedure دو نوع کامنت ارائه می دهد: کامنت های خطی و کامنت های گروهی. مثال های زیر به شما چگونگی افزودن کامنت ها را با استفاده از هر دو تکنیک نشان می دهند. کامنت ها در پنجره ی query مربوط به SQL Server به رنگ سبز نشان داده می شوند.

کامنت های خطی:

برای ایجاد کامنت های خطی فقط کافیست از دو خط تیره "--" در جلوی کدی که می خواهید به آن کامنت اضافه کنید، استفاده کنید. با استفاده از این تکنیک می توانید یک یا چند خط کامنت بگذارید.

در این مثال کل خط کامنت می باشد:

‎--this procedure gets a list of addresses based ‎
‎--on the city value that is passed
CREATE PROCEDURE uspGetAddress @City nvarchar(30)‎
AS
SELECT * ‎
FROM AdventureWorks.Person.Address
WHERE City = @City
GO

مثال بعد به شما نشان می دهد که چگونه کامنت را روی همان خط قرار داد:

‎--this procedure gets a list of addresses based on the city value that is ‎passed
CREATE PROCEDURE uspGetAddress @City nvarchar(30)‎
AS
SELECT * ‎
FROM AdventureWorks.Person.Address
WHERE City = @City --the @City parameter value will narrow the search ‎criteria
GO

برای ایجاد کامنت های گروهی، گروه با "/*" شروع شده و با "*/" تمام می شود. هر چیز در داخل آن گروه یک بخش از کامنت خواهد بود.

‎/* ‎
‎-this procedure gets a list of addresses based ‎
‎ on the city value that is passed
‎-this procedure is used by the HR system      ‎
‎*/‎
CREATE PROCEDURE uspGetAddress @City nvarchar(30)‎
AS
SELECT * ‎
FROM AdventureWorks.Person.Address
WHERE City = @City
GO

ترکیب کامنت های خطی و گروهی:

شما می توانید از هر دو نوع کامنت در یک stored procedure استفاده کنید.

‎/* ‎
‎-this procedure gets a list of addresses based ‎
‎ on the city value that is passed
‎-this procedure is used by the HR system      ‎
‎*/‎
CREATE PROCEDURE uspGetAddress @City nvarchar(30)‎
AS
SELECT * ‎
FROM AdventureWorks.Person.Address
WHERE City = @City -- the @City parameter value will narrow the search ‎criteria
GO